sailpoint-api-client 1.3.6 → 1.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/api.ts +1078 -971
- package/beta/common.ts +9 -2
- package/beta/package.json +1 -1
- package/configuration.ts +1 -0
- package/dist/beta/api.d.ts +599 -528
- package/dist/beta/api.js +1181 -1153
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +7 -1
- package/dist/beta/common.js.map +1 -1
- package/dist/configuration.d.ts +1 -0
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +65 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/v2024/api.d.ts +74558 -0
- package/dist/v2024/api.js +68142 -0
- package/dist/v2024/api.js.map +1 -0
- package/dist/v2024/base.d.ts +55 -0
- package/dist/v2024/base.js +86 -0
- package/dist/v2024/base.js.map +1 -0
- package/dist/v2024/common.d.ts +65 -0
- package/dist/v2024/common.js +257 -0
- package/dist/v2024/common.js.map +1 -0
- package/dist/v2024/configuration.d.ts +83 -0
- package/dist/v2024/configuration.js +45 -0
- package/dist/v2024/configuration.js.map +1 -0
- package/dist/v2024/index.d.ts +12 -0
- package/dist/v2024/index.js +31 -0
- package/dist/v2024/index.js.map +1 -0
- package/dist/v3/api.d.ts +1825 -207
- package/dist/v3/api.js +2422 -794
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +7 -1
- package/dist/v3/common.js.map +1 -1
- package/index.spec.ts +44 -1
- package/index.ts +3 -0
- package/package.json +1 -1
- package/v2024/.openapi-generator/FILES +12 -0
- package/v2024/.openapi-generator/VERSION +1 -0
- package/v2024/.openapi-generator-ignore +23 -0
- package/v2024/README.md +45 -0
- package/v2024/api.ts +107265 -0
- package/v2024/base.ts +71 -0
- package/v2024/common.ts +153 -0
- package/v2024/configuration.ts +101 -0
- package/v2024/git_push.sh +57 -0
- package/v2024/index.ts +17 -0
- package/v2024/package.json +35 -0
- package/v2024/tsconfig.json +21 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +3052 -684
- package/v3/common.ts +9 -2
- package/v3/package.json +1 -1
package/beta/api.ts
CHANGED
|
@@ -167,11 +167,29 @@ export interface AccessItemAccessProfileResponseBeta {
|
|
|
167
167
|
*/
|
|
168
168
|
'entitlementCount'?: string;
|
|
169
169
|
/**
|
|
170
|
-
* the name of
|
|
170
|
+
* the name of
|
|
171
171
|
* @type {string}
|
|
172
172
|
* @memberof AccessItemAccessProfileResponseBeta
|
|
173
173
|
*/
|
|
174
174
|
'appDisplayName'?: string;
|
|
175
|
+
/**
|
|
176
|
+
* the date the access profile is no longer assigned to the specified identity
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
179
|
+
*/
|
|
180
|
+
'removeDate'?: string;
|
|
181
|
+
/**
|
|
182
|
+
* indicates whether the access profile is standalone
|
|
183
|
+
* @type {boolean}
|
|
184
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
185
|
+
*/
|
|
186
|
+
'standalone': boolean;
|
|
187
|
+
/**
|
|
188
|
+
* indicates whether the access profile is
|
|
189
|
+
* @type {boolean}
|
|
190
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
191
|
+
*/
|
|
192
|
+
'revocable': boolean;
|
|
175
193
|
}
|
|
176
194
|
/**
|
|
177
195
|
*
|
|
@@ -241,7 +259,7 @@ export interface AccessItemAppResponseBeta {
|
|
|
241
259
|
*/
|
|
242
260
|
'id'?: string;
|
|
243
261
|
/**
|
|
244
|
-
* the access
|
|
262
|
+
* the access item display name
|
|
245
263
|
* @type {string}
|
|
246
264
|
* @memberof AccessItemAppResponseBeta
|
|
247
265
|
*/
|
|
@@ -252,6 +270,12 @@ export interface AccessItemAppResponseBeta {
|
|
|
252
270
|
* @memberof AccessItemAppResponseBeta
|
|
253
271
|
*/
|
|
254
272
|
'sourceName'?: string;
|
|
273
|
+
/**
|
|
274
|
+
* the app role id
|
|
275
|
+
* @type {string}
|
|
276
|
+
* @memberof AccessItemAppResponseBeta
|
|
277
|
+
*/
|
|
278
|
+
'appRoleId'?: string;
|
|
255
279
|
}
|
|
256
280
|
/**
|
|
257
281
|
* Identity who approved the access item request.
|
|
@@ -427,6 +451,24 @@ export interface AccessItemEntitlementResponseBeta {
|
|
|
427
451
|
* @memberof AccessItemEntitlementResponseBeta
|
|
428
452
|
*/
|
|
429
453
|
'displayName'?: string;
|
|
454
|
+
/**
|
|
455
|
+
* indicates whether the entitlement is standalone
|
|
456
|
+
* @type {boolean}
|
|
457
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
458
|
+
*/
|
|
459
|
+
'standalone': boolean;
|
|
460
|
+
/**
|
|
461
|
+
* indicates whether the entitlement is privileged
|
|
462
|
+
* @type {boolean}
|
|
463
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
464
|
+
*/
|
|
465
|
+
'privileged': boolean;
|
|
466
|
+
/**
|
|
467
|
+
* indicates whether the entitlement is cloud governed
|
|
468
|
+
* @type {boolean}
|
|
469
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
470
|
+
*/
|
|
471
|
+
'cloudGoverned': boolean;
|
|
430
472
|
}
|
|
431
473
|
/**
|
|
432
474
|
* Access item owner\'s identity.
|
|
@@ -689,6 +731,18 @@ export interface AccessItemRoleResponseBeta {
|
|
|
689
731
|
* @memberof AccessItemRoleResponseBeta
|
|
690
732
|
*/
|
|
691
733
|
'sourceName'?: string;
|
|
734
|
+
/**
|
|
735
|
+
* the date the role is no longer assigned to the specified identity
|
|
736
|
+
* @type {string}
|
|
737
|
+
* @memberof AccessItemRoleResponseBeta
|
|
738
|
+
*/
|
|
739
|
+
'removeDate'?: string;
|
|
740
|
+
/**
|
|
741
|
+
* indicates whether the role is revocable
|
|
742
|
+
* @type {boolean}
|
|
743
|
+
* @memberof AccessItemRoleResponseBeta
|
|
744
|
+
*/
|
|
745
|
+
'revocable': boolean;
|
|
692
746
|
}
|
|
693
747
|
/**
|
|
694
748
|
*
|
|
@@ -7379,12 +7433,6 @@ export interface CompletedApprovalBeta {
|
|
|
7379
7433
|
* @memberof CompletedApprovalBeta
|
|
7380
7434
|
*/
|
|
7381
7435
|
'clientMetadata'?: { [key: string]: string; };
|
|
7382
|
-
/**
|
|
7383
|
-
* Information about the requested accounts
|
|
7384
|
-
* @type {string}
|
|
7385
|
-
* @memberof CompletedApprovalBeta
|
|
7386
|
-
*/
|
|
7387
|
-
'requestedAccounts'?: string | null;
|
|
7388
7436
|
}
|
|
7389
7437
|
/**
|
|
7390
7438
|
* 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.
|
|
@@ -11182,7 +11230,7 @@ export interface FormElementDynamicDataSourceBeta {
|
|
|
11182
11230
|
*/
|
|
11183
11231
|
'config'?: FormElementDynamicDataSourceConfigBeta;
|
|
11184
11232
|
/**
|
|
11185
|
-
* DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch
|
|
11233
|
+
* DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput
|
|
11186
11234
|
* @type {string}
|
|
11187
11235
|
* @memberof FormElementDynamicDataSourceBeta
|
|
11188
11236
|
*/
|
|
@@ -11192,7 +11240,8 @@ export interface FormElementDynamicDataSourceBeta {
|
|
|
11192
11240
|
export const FormElementDynamicDataSourceBetaDataSourceTypeEnum = {
|
|
11193
11241
|
Static: 'STATIC',
|
|
11194
11242
|
Internal: 'INTERNAL',
|
|
11195
|
-
Search: 'SEARCH'
|
|
11243
|
+
Search: 'SEARCH',
|
|
11244
|
+
FormInput: 'FORM_INPUT'
|
|
11196
11245
|
} as const;
|
|
11197
11246
|
|
|
11198
11247
|
export type FormElementDynamicDataSourceBetaDataSourceTypeEnum = typeof FormElementDynamicDataSourceBetaDataSourceTypeEnum[keyof typeof FormElementDynamicDataSourceBetaDataSourceTypeEnum];
|
|
@@ -12116,25 +12165,6 @@ export interface GenerateRandomStringBeta {
|
|
|
12116
12165
|
*/
|
|
12117
12166
|
'requiresPeriodicRefresh'?: boolean;
|
|
12118
12167
|
}
|
|
12119
|
-
/**
|
|
12120
|
-
*
|
|
12121
|
-
* @export
|
|
12122
|
-
* @interface GenericRuleBeta
|
|
12123
|
-
*/
|
|
12124
|
-
export interface GenericRuleBeta {
|
|
12125
|
-
/**
|
|
12126
|
-
* This is the name of the Generic rule that needs to be invoked by the transform
|
|
12127
|
-
* @type {string}
|
|
12128
|
-
* @memberof GenericRuleBeta
|
|
12129
|
-
*/
|
|
12130
|
-
'name': string;
|
|
12131
|
-
/**
|
|
12132
|
-
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
12133
|
-
* @type {boolean}
|
|
12134
|
-
* @memberof GenericRuleBeta
|
|
12135
|
-
*/
|
|
12136
|
-
'requiresPeriodicRefresh'?: boolean;
|
|
12137
|
-
}
|
|
12138
12168
|
/**
|
|
12139
12169
|
* @type GetActiveCampaigns200ResponseInnerBeta
|
|
12140
12170
|
* @export
|
|
@@ -14363,6 +14393,27 @@ export interface IdentityWithNewAccessBeta {
|
|
|
14363
14393
|
*/
|
|
14364
14394
|
'accessRefs': Array<IdentityWithNewAccessAccessRefsInnerBeta>;
|
|
14365
14395
|
}
|
|
14396
|
+
/**
|
|
14397
|
+
* 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.
|
|
14398
|
+
* @export
|
|
14399
|
+
* @interface ImportAccountsRequest1Beta
|
|
14400
|
+
*/
|
|
14401
|
+
export interface ImportAccountsRequest1Beta {
|
|
14402
|
+
/**
|
|
14403
|
+
* Use this flag to reprocess every account whether or not the data has changed.
|
|
14404
|
+
* @type {string}
|
|
14405
|
+
* @memberof ImportAccountsRequest1Beta
|
|
14406
|
+
*/
|
|
14407
|
+
'disableOptimization'?: ImportAccountsRequest1BetaDisableOptimizationEnum;
|
|
14408
|
+
}
|
|
14409
|
+
|
|
14410
|
+
export const ImportAccountsRequest1BetaDisableOptimizationEnum = {
|
|
14411
|
+
True: 'true',
|
|
14412
|
+
False: 'false'
|
|
14413
|
+
} as const;
|
|
14414
|
+
|
|
14415
|
+
export type ImportAccountsRequest1BetaDisableOptimizationEnum = typeof ImportAccountsRequest1BetaDisableOptimizationEnum[keyof typeof ImportAccountsRequest1BetaDisableOptimizationEnum];
|
|
14416
|
+
|
|
14366
14417
|
/**
|
|
14367
14418
|
*
|
|
14368
14419
|
* @export
|
|
@@ -14380,8 +14431,16 @@ export interface ImportAccountsRequestBeta {
|
|
|
14380
14431
|
* @type {string}
|
|
14381
14432
|
* @memberof ImportAccountsRequestBeta
|
|
14382
14433
|
*/
|
|
14383
|
-
'disableOptimization'?:
|
|
14434
|
+
'disableOptimization'?: ImportAccountsRequestBetaDisableOptimizationEnum;
|
|
14384
14435
|
}
|
|
14436
|
+
|
|
14437
|
+
export const ImportAccountsRequestBetaDisableOptimizationEnum = {
|
|
14438
|
+
True: 'true',
|
|
14439
|
+
False: 'false'
|
|
14440
|
+
} as const;
|
|
14441
|
+
|
|
14442
|
+
export type ImportAccountsRequestBetaDisableOptimizationEnum = typeof ImportAccountsRequestBetaDisableOptimizationEnum[keyof typeof ImportAccountsRequestBetaDisableOptimizationEnum];
|
|
14443
|
+
|
|
14385
14444
|
/**
|
|
14386
14445
|
*
|
|
14387
14446
|
* @export
|
|
@@ -16479,11 +16538,11 @@ export interface ManualDiscoverApplicationsTemplateBeta {
|
|
|
16479
16538
|
*/
|
|
16480
16539
|
'application_name'?: string;
|
|
16481
16540
|
/**
|
|
16482
|
-
* Description of the example application
|
|
16541
|
+
* Description of the example application.
|
|
16483
16542
|
* @type {string}
|
|
16484
16543
|
* @memberof ManualDiscoverApplicationsTemplateBeta
|
|
16485
16544
|
*/
|
|
16486
|
-
'
|
|
16545
|
+
'description'?: string;
|
|
16487
16546
|
}
|
|
16488
16547
|
/**
|
|
16489
16548
|
*
|
|
@@ -23942,7 +24001,7 @@ export interface RoleTargetDtoBeta {
|
|
|
23942
24001
|
* @type RuleBeta
|
|
23943
24002
|
* @export
|
|
23944
24003
|
*/
|
|
23945
|
-
export type RuleBeta = GenerateRandomStringBeta |
|
|
24004
|
+
export type RuleBeta = GenerateRandomStringBeta | GetReferenceIdentityAttributeBeta | TransformRuleBeta;
|
|
23946
24005
|
|
|
23947
24006
|
/**
|
|
23948
24007
|
*
|
|
@@ -25138,19 +25197,6 @@ export const SendAccountVerificationRequestBetaViaEnum = {
|
|
|
25138
25197
|
|
|
25139
25198
|
export type SendAccountVerificationRequestBetaViaEnum = typeof SendAccountVerificationRequestBetaViaEnum[keyof typeof SendAccountVerificationRequestBetaViaEnum];
|
|
25140
25199
|
|
|
25141
|
-
/**
|
|
25142
|
-
*
|
|
25143
|
-
* @export
|
|
25144
|
-
* @interface SendManualDiscoverApplicationsCsvTemplateRequestBeta
|
|
25145
|
-
*/
|
|
25146
|
-
export interface SendManualDiscoverApplicationsCsvTemplateRequestBeta {
|
|
25147
|
-
/**
|
|
25148
|
-
*
|
|
25149
|
-
* @type {any}
|
|
25150
|
-
* @memberof SendManualDiscoverApplicationsCsvTemplateRequestBeta
|
|
25151
|
-
*/
|
|
25152
|
-
'csvFile': any;
|
|
25153
|
-
}
|
|
25154
25200
|
/**
|
|
25155
25201
|
*
|
|
25156
25202
|
* @export
|
|
@@ -29953,6 +29999,25 @@ export const TransformReadBetaTypeEnum = {
|
|
|
29953
29999
|
|
|
29954
30000
|
export type TransformReadBetaTypeEnum = typeof TransformReadBetaTypeEnum[keyof typeof TransformReadBetaTypeEnum];
|
|
29955
30001
|
|
|
30002
|
+
/**
|
|
30003
|
+
*
|
|
30004
|
+
* @export
|
|
30005
|
+
* @interface TransformRuleBeta
|
|
30006
|
+
*/
|
|
30007
|
+
export interface TransformRuleBeta {
|
|
30008
|
+
/**
|
|
30009
|
+
* This is the name of the Transform rule that needs to be invoked by the transform
|
|
30010
|
+
* @type {string}
|
|
30011
|
+
* @memberof TransformRuleBeta
|
|
30012
|
+
*/
|
|
30013
|
+
'name': string;
|
|
30014
|
+
/**
|
|
30015
|
+
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
30016
|
+
* @type {boolean}
|
|
30017
|
+
* @memberof TransformRuleBeta
|
|
30018
|
+
*/
|
|
30019
|
+
'requiresPeriodicRefresh'?: boolean;
|
|
30020
|
+
}
|
|
29956
30021
|
/**
|
|
29957
30022
|
*
|
|
29958
30023
|
* @export
|
|
@@ -32542,13 +32607,13 @@ export const AccessProfilesBetaApiAxiosParamCreator = function (configuration?:
|
|
|
32542
32607
|
};
|
|
32543
32608
|
},
|
|
32544
32609
|
/**
|
|
32545
|
-
*
|
|
32610
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
|
|
32546
32611
|
* @summary List Access Profile\'s Entitlements
|
|
32547
|
-
* @param {string} id ID of the containing
|
|
32612
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
32548
32613
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32549
32614
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32550
32615
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32551
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
32616
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
32552
32617
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
32553
32618
|
* @param {*} [axiosOptions] Override http request option.
|
|
32554
32619
|
* @throws {RequiredError}
|
|
@@ -32611,7 +32676,7 @@ export const AccessProfilesBetaApiAxiosParamCreator = function (configuration?:
|
|
|
32611
32676
|
/**
|
|
32612
32677
|
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
32613
32678
|
* @summary List Access Profiles
|
|
32614
|
-
* @param {string} [forSubadmin] If provided, 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
|
|
32679
|
+
* @param {string} [forSubadmin] If provided, 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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
32615
32680
|
* @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.
|
|
32616
32681
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32617
32682
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -32833,13 +32898,13 @@ export const AccessProfilesBetaApiFp = function(configuration?: Configuration) {
|
|
|
32833
32898
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32834
32899
|
},
|
|
32835
32900
|
/**
|
|
32836
|
-
*
|
|
32901
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
|
|
32837
32902
|
* @summary List Access Profile\'s Entitlements
|
|
32838
|
-
* @param {string} id ID of the containing
|
|
32903
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
32839
32904
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32840
32905
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32841
32906
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32842
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
32907
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
32843
32908
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
32844
32909
|
* @param {*} [axiosOptions] Override http request option.
|
|
32845
32910
|
* @throws {RequiredError}
|
|
@@ -32851,7 +32916,7 @@ export const AccessProfilesBetaApiFp = function(configuration?: Configuration) {
|
|
|
32851
32916
|
/**
|
|
32852
32917
|
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
32853
32918
|
* @summary List Access Profiles
|
|
32854
|
-
* @param {string} [forSubadmin] If provided, 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
|
|
32919
|
+
* @param {string} [forSubadmin] If provided, 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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
32855
32920
|
* @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.
|
|
32856
32921
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32857
32922
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -32940,13 +33005,13 @@ export const AccessProfilesBetaApiFactory = function (configuration?: Configurat
|
|
|
32940
33005
|
return localVarFp.getAccessProfile(id, axiosOptions).then((request) => request(axios, basePath));
|
|
32941
33006
|
},
|
|
32942
33007
|
/**
|
|
32943
|
-
*
|
|
33008
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
|
|
32944
33009
|
* @summary List Access Profile\'s Entitlements
|
|
32945
|
-
* @param {string} id ID of the containing
|
|
33010
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
32946
33011
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32947
33012
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32948
33013
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32949
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
33014
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
32950
33015
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
32951
33016
|
* @param {*} [axiosOptions] Override http request option.
|
|
32952
33017
|
* @throws {RequiredError}
|
|
@@ -32957,7 +33022,7 @@ export const AccessProfilesBetaApiFactory = function (configuration?: Configurat
|
|
|
32957
33022
|
/**
|
|
32958
33023
|
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
32959
33024
|
* @summary List Access Profiles
|
|
32960
|
-
* @param {string} [forSubadmin] If provided, 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
|
|
33025
|
+
* @param {string} [forSubadmin] If provided, 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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
32961
33026
|
* @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.
|
|
32962
33027
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
32963
33028
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -33058,7 +33123,7 @@ export interface AccessProfilesBetaApiGetAccessProfileRequest {
|
|
|
33058
33123
|
*/
|
|
33059
33124
|
export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
33060
33125
|
/**
|
|
33061
|
-
* ID of the containing
|
|
33126
|
+
* ID of the access profile containing the entitlements.
|
|
33062
33127
|
* @type {string}
|
|
33063
33128
|
* @memberof AccessProfilesBetaApiGetAccessProfileEntitlements
|
|
33064
33129
|
*/
|
|
@@ -33086,7 +33151,7 @@ export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
|
33086
33151
|
readonly count?: boolean
|
|
33087
33152
|
|
|
33088
33153
|
/**
|
|
33089
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
33154
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
33090
33155
|
* @type {string}
|
|
33091
33156
|
* @memberof AccessProfilesBetaApiGetAccessProfileEntitlements
|
|
33092
33157
|
*/
|
|
@@ -33107,7 +33172,7 @@ export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
|
33107
33172
|
*/
|
|
33108
33173
|
export interface AccessProfilesBetaApiListAccessProfilesRequest {
|
|
33109
33174
|
/**
|
|
33110
|
-
* If provided, 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
|
|
33175
|
+
* If provided, 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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
33111
33176
|
* @type {string}
|
|
33112
33177
|
* @memberof AccessProfilesBetaApiListAccessProfiles
|
|
33113
33178
|
*/
|
|
@@ -33254,7 +33319,7 @@ export class AccessProfilesBetaApi extends BaseAPI {
|
|
|
33254
33319
|
}
|
|
33255
33320
|
|
|
33256
33321
|
/**
|
|
33257
|
-
*
|
|
33322
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
|
|
33258
33323
|
* @summary List Access Profile\'s Entitlements
|
|
33259
33324
|
* @param {AccessProfilesBetaApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters.
|
|
33260
33325
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36111,7 +36176,7 @@ export const AccountsBetaApiAxiosParamCreator = function (configuration?: Config
|
|
|
36111
36176
|
};
|
|
36112
36177
|
},
|
|
36113
36178
|
/**
|
|
36114
|
-
* Use this API to update an account with a PUT request.
|
|
36179
|
+
* 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.**
|
|
36115
36180
|
* @summary Update Account
|
|
36116
36181
|
* @param {string} id Account ID.
|
|
36117
36182
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -36249,18 +36314,18 @@ export const AccountsBetaApiAxiosParamCreator = function (configuration?: Config
|
|
|
36249
36314
|
};
|
|
36250
36315
|
},
|
|
36251
36316
|
/**
|
|
36252
|
-
*
|
|
36317
|
+
* 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.
|
|
36253
36318
|
* @summary Update Account
|
|
36254
36319
|
* @param {string} id Account ID.
|
|
36255
|
-
* @param {Array<
|
|
36320
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
36256
36321
|
* @param {*} [axiosOptions] Override http request option.
|
|
36257
36322
|
* @throws {RequiredError}
|
|
36258
36323
|
*/
|
|
36259
|
-
updateAccount: async (id: string,
|
|
36324
|
+
updateAccount: async (id: string, requestBody: Array<object>, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
36260
36325
|
// verify required parameter 'id' is not null or undefined
|
|
36261
36326
|
assertParamExists('updateAccount', 'id', id)
|
|
36262
|
-
// verify required parameter '
|
|
36263
|
-
assertParamExists('updateAccount', '
|
|
36327
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
36328
|
+
assertParamExists('updateAccount', 'requestBody', requestBody)
|
|
36264
36329
|
const localVarPath = `/accounts/{id}`
|
|
36265
36330
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
36266
36331
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -36289,7 +36354,7 @@ export const AccountsBetaApiAxiosParamCreator = function (configuration?: Config
|
|
|
36289
36354
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36290
36355
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36291
36356
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
36292
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
36357
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
|
|
36293
36358
|
|
|
36294
36359
|
return {
|
|
36295
36360
|
url: toPathString(localVarUrlObj),
|
|
@@ -36449,7 +36514,7 @@ export const AccountsBetaApiFp = function(configuration?: Configuration) {
|
|
|
36449
36514
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
36450
36515
|
},
|
|
36451
36516
|
/**
|
|
36452
|
-
* Use this API to update an account with a PUT request.
|
|
36517
|
+
* 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.**
|
|
36453
36518
|
* @summary Update Account
|
|
36454
36519
|
* @param {string} id Account ID.
|
|
36455
36520
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -36484,15 +36549,15 @@ export const AccountsBetaApiFp = function(configuration?: Configuration) {
|
|
|
36484
36549
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
36485
36550
|
},
|
|
36486
36551
|
/**
|
|
36487
|
-
*
|
|
36552
|
+
* 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.
|
|
36488
36553
|
* @summary Update Account
|
|
36489
36554
|
* @param {string} id Account ID.
|
|
36490
|
-
* @param {Array<
|
|
36555
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
36491
36556
|
* @param {*} [axiosOptions] Override http request option.
|
|
36492
36557
|
* @throws {RequiredError}
|
|
36493
36558
|
*/
|
|
36494
|
-
async updateAccount(id: string,
|
|
36495
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id,
|
|
36559
|
+
async updateAccount(id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
36560
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions);
|
|
36496
36561
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
36497
36562
|
},
|
|
36498
36563
|
}
|
|
@@ -36636,7 +36701,7 @@ export const AccountsBetaApiFactory = function (configuration?: Configuration, b
|
|
|
36636
36701
|
return localVarFp.listAccounts(detailLevel, limit, offset, count, filters, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
36637
36702
|
},
|
|
36638
36703
|
/**
|
|
36639
|
-
* Use this API to update an account with a PUT request.
|
|
36704
|
+
* 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.**
|
|
36640
36705
|
* @summary Update Account
|
|
36641
36706
|
* @param {string} id Account ID.
|
|
36642
36707
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -36668,15 +36733,15 @@ export const AccountsBetaApiFactory = function (configuration?: Configuration, b
|
|
|
36668
36733
|
return localVarFp.unlockAccount(id, accountUnlockRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
36669
36734
|
},
|
|
36670
36735
|
/**
|
|
36671
|
-
*
|
|
36736
|
+
* 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.
|
|
36672
36737
|
* @summary Update Account
|
|
36673
36738
|
* @param {string} id Account ID.
|
|
36674
|
-
* @param {Array<
|
|
36739
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
36675
36740
|
* @param {*} [axiosOptions] Override http request option.
|
|
36676
36741
|
* @throws {RequiredError}
|
|
36677
36742
|
*/
|
|
36678
|
-
updateAccount(id: string,
|
|
36679
|
-
return localVarFp.updateAccount(id,
|
|
36743
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: any): AxiosPromise<object> {
|
|
36744
|
+
return localVarFp.updateAccount(id, requestBody, axiosOptions).then((request) => request(axios, basePath));
|
|
36680
36745
|
},
|
|
36681
36746
|
};
|
|
36682
36747
|
};
|
|
@@ -36990,10 +37055,10 @@ export interface AccountsBetaApiUpdateAccountRequest {
|
|
|
36990
37055
|
|
|
36991
37056
|
/**
|
|
36992
37057
|
* A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
36993
|
-
* @type {Array<
|
|
37058
|
+
* @type {Array<object>}
|
|
36994
37059
|
* @memberof AccountsBetaApiUpdateAccount
|
|
36995
37060
|
*/
|
|
36996
|
-
readonly
|
|
37061
|
+
readonly requestBody: Array<object>
|
|
36997
37062
|
}
|
|
36998
37063
|
|
|
36999
37064
|
/**
|
|
@@ -37148,7 +37213,7 @@ export class AccountsBetaApi extends BaseAPI {
|
|
|
37148
37213
|
}
|
|
37149
37214
|
|
|
37150
37215
|
/**
|
|
37151
|
-
* Use this API to update an account with a PUT request.
|
|
37216
|
+
* 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.**
|
|
37152
37217
|
* @summary Update Account
|
|
37153
37218
|
* @param {AccountsBetaApiPutAccountRequest} requestParameters Request parameters.
|
|
37154
37219
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37184,7 +37249,7 @@ export class AccountsBetaApi extends BaseAPI {
|
|
|
37184
37249
|
}
|
|
37185
37250
|
|
|
37186
37251
|
/**
|
|
37187
|
-
*
|
|
37252
|
+
* 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.
|
|
37188
37253
|
* @summary Update Account
|
|
37189
37254
|
* @param {AccountsBetaApiUpdateAccountRequest} requestParameters Request parameters.
|
|
37190
37255
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37192,7 +37257,409 @@ export class AccountsBetaApi extends BaseAPI {
|
|
|
37192
37257
|
* @memberof AccountsBetaApi
|
|
37193
37258
|
*/
|
|
37194
37259
|
public updateAccount(requestParameters: AccountsBetaApiUpdateAccountRequest, axiosOptions?: AxiosRequestConfig) {
|
|
37195
|
-
return AccountsBetaApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.
|
|
37260
|
+
return AccountsBetaApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
37261
|
+
}
|
|
37262
|
+
}
|
|
37263
|
+
|
|
37264
|
+
|
|
37265
|
+
/**
|
|
37266
|
+
* ApplicationDiscoveryBetaApi - axios parameter creator
|
|
37267
|
+
* @export
|
|
37268
|
+
*/
|
|
37269
|
+
export const ApplicationDiscoveryBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
37270
|
+
return {
|
|
37271
|
+
/**
|
|
37272
|
+
* Fetches 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.
|
|
37273
|
+
* @summary Retrieve discovered applications for tenant
|
|
37274
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37275
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37276
|
+
* @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*
|
|
37277
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37278
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37279
|
+
* @throws {RequiredError}
|
|
37280
|
+
*/
|
|
37281
|
+
getDiscoveredApplications: async (limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37282
|
+
const localVarPath = `/discovered-applications`;
|
|
37283
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37284
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37285
|
+
let baseOptions;
|
|
37286
|
+
if (configuration) {
|
|
37287
|
+
baseOptions = configuration.baseOptions;
|
|
37288
|
+
}
|
|
37289
|
+
|
|
37290
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
37291
|
+
const localVarHeaderParameter = {} as any;
|
|
37292
|
+
const localVarQueryParameter = {} as any;
|
|
37293
|
+
|
|
37294
|
+
// authentication UserContextAuth required
|
|
37295
|
+
// oauth required
|
|
37296
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37297
|
+
|
|
37298
|
+
// authentication UserContextAuth required
|
|
37299
|
+
// oauth required
|
|
37300
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37301
|
+
|
|
37302
|
+
if (limit !== undefined) {
|
|
37303
|
+
localVarQueryParameter['limit'] = limit;
|
|
37304
|
+
}
|
|
37305
|
+
|
|
37306
|
+
if (offset !== undefined) {
|
|
37307
|
+
localVarQueryParameter['offset'] = offset;
|
|
37308
|
+
}
|
|
37309
|
+
|
|
37310
|
+
if (filter !== undefined) {
|
|
37311
|
+
localVarQueryParameter['filter'] = filter;
|
|
37312
|
+
}
|
|
37313
|
+
|
|
37314
|
+
if (sorters !== undefined) {
|
|
37315
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
37316
|
+
}
|
|
37317
|
+
|
|
37318
|
+
|
|
37319
|
+
|
|
37320
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37321
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37322
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
37323
|
+
|
|
37324
|
+
return {
|
|
37325
|
+
url: toPathString(localVarUrlObj),
|
|
37326
|
+
axiosOptions: localVarRequestOptions,
|
|
37327
|
+
};
|
|
37328
|
+
},
|
|
37329
|
+
/**
|
|
37330
|
+
* This endpoint allows the user to 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.
|
|
37331
|
+
* @summary CSV template download for discovery
|
|
37332
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37333
|
+
* @throws {RequiredError}
|
|
37334
|
+
*/
|
|
37335
|
+
getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37336
|
+
const localVarPath = `/manual-discover-applications-template`;
|
|
37337
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37338
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37339
|
+
let baseOptions;
|
|
37340
|
+
if (configuration) {
|
|
37341
|
+
baseOptions = configuration.baseOptions;
|
|
37342
|
+
}
|
|
37343
|
+
|
|
37344
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
37345
|
+
const localVarHeaderParameter = {} as any;
|
|
37346
|
+
const localVarQueryParameter = {} as any;
|
|
37347
|
+
|
|
37348
|
+
// authentication UserContextAuth required
|
|
37349
|
+
// oauth required
|
|
37350
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37351
|
+
|
|
37352
|
+
// authentication UserContextAuth required
|
|
37353
|
+
// oauth required
|
|
37354
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37355
|
+
|
|
37356
|
+
|
|
37357
|
+
|
|
37358
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37359
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37360
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
37361
|
+
|
|
37362
|
+
return {
|
|
37363
|
+
url: toPathString(localVarUrlObj),
|
|
37364
|
+
axiosOptions: localVarRequestOptions,
|
|
37365
|
+
};
|
|
37366
|
+
},
|
|
37367
|
+
/**
|
|
37368
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
37369
|
+
* @summary List vendor connector mappings
|
|
37370
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37371
|
+
* @throws {RequiredError}
|
|
37372
|
+
*/
|
|
37373
|
+
getVendorConnectorMappings: async (axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37374
|
+
const localVarPath = `/vendor-connector-mappings`;
|
|
37375
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37376
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37377
|
+
let baseOptions;
|
|
37378
|
+
if (configuration) {
|
|
37379
|
+
baseOptions = configuration.baseOptions;
|
|
37380
|
+
}
|
|
37381
|
+
|
|
37382
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
37383
|
+
const localVarHeaderParameter = {} as any;
|
|
37384
|
+
const localVarQueryParameter = {} as any;
|
|
37385
|
+
|
|
37386
|
+
// authentication UserContextAuth required
|
|
37387
|
+
// oauth required
|
|
37388
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37389
|
+
|
|
37390
|
+
// authentication UserContextAuth required
|
|
37391
|
+
// oauth required
|
|
37392
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37393
|
+
|
|
37394
|
+
|
|
37395
|
+
|
|
37396
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37397
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37398
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
37399
|
+
|
|
37400
|
+
return {
|
|
37401
|
+
url: toPathString(localVarUrlObj),
|
|
37402
|
+
axiosOptions: localVarRequestOptions,
|
|
37403
|
+
};
|
|
37404
|
+
},
|
|
37405
|
+
/**
|
|
37406
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
37407
|
+
* @summary CSV Upload to discover applications
|
|
37408
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
37409
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37410
|
+
* @throws {RequiredError}
|
|
37411
|
+
*/
|
|
37412
|
+
sendManualDiscoverApplicationsCsvTemplate: async (file: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37413
|
+
// verify required parameter 'file' is not null or undefined
|
|
37414
|
+
assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file)
|
|
37415
|
+
const localVarPath = `/manual-discover-applications`;
|
|
37416
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37417
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37418
|
+
let baseOptions;
|
|
37419
|
+
if (configuration) {
|
|
37420
|
+
baseOptions = configuration.baseOptions;
|
|
37421
|
+
}
|
|
37422
|
+
|
|
37423
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
37424
|
+
const localVarHeaderParameter = {} as any;
|
|
37425
|
+
const localVarQueryParameter = {} as any;
|
|
37426
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
37427
|
+
|
|
37428
|
+
// authentication UserContextAuth required
|
|
37429
|
+
// oauth required
|
|
37430
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37431
|
+
|
|
37432
|
+
// authentication UserContextAuth required
|
|
37433
|
+
// oauth required
|
|
37434
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
37435
|
+
|
|
37436
|
+
|
|
37437
|
+
if (file !== undefined) {
|
|
37438
|
+
localVarFormParams.append('file', file as any);
|
|
37439
|
+
}
|
|
37440
|
+
|
|
37441
|
+
|
|
37442
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
37443
|
+
|
|
37444
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37445
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37446
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
37447
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
37448
|
+
|
|
37449
|
+
return {
|
|
37450
|
+
url: toPathString(localVarUrlObj),
|
|
37451
|
+
axiosOptions: localVarRequestOptions,
|
|
37452
|
+
};
|
|
37453
|
+
},
|
|
37454
|
+
}
|
|
37455
|
+
};
|
|
37456
|
+
|
|
37457
|
+
/**
|
|
37458
|
+
* ApplicationDiscoveryBetaApi - functional programming interface
|
|
37459
|
+
* @export
|
|
37460
|
+
*/
|
|
37461
|
+
export const ApplicationDiscoveryBetaApiFp = function(configuration?: Configuration) {
|
|
37462
|
+
const localVarAxiosParamCreator = ApplicationDiscoveryBetaApiAxiosParamCreator(configuration)
|
|
37463
|
+
return {
|
|
37464
|
+
/**
|
|
37465
|
+
* Fetches 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.
|
|
37466
|
+
* @summary Retrieve discovered applications for tenant
|
|
37467
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37468
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37469
|
+
* @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*
|
|
37470
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37471
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37472
|
+
* @throws {RequiredError}
|
|
37473
|
+
*/
|
|
37474
|
+
async getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>> {
|
|
37475
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, filter, sorters, axiosOptions);
|
|
37476
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37477
|
+
},
|
|
37478
|
+
/**
|
|
37479
|
+
* This endpoint allows the user to 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.
|
|
37480
|
+
* @summary CSV template download for discovery
|
|
37481
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37482
|
+
* @throws {RequiredError}
|
|
37483
|
+
*/
|
|
37484
|
+
async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsTemplateBeta>> {
|
|
37485
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions);
|
|
37486
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37487
|
+
},
|
|
37488
|
+
/**
|
|
37489
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
37490
|
+
* @summary List vendor connector mappings
|
|
37491
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37492
|
+
* @throws {RequiredError}
|
|
37493
|
+
*/
|
|
37494
|
+
async getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMappingBeta>>> {
|
|
37495
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVendorConnectorMappings(axiosOptions);
|
|
37496
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37497
|
+
},
|
|
37498
|
+
/**
|
|
37499
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
37500
|
+
* @summary CSV Upload to discover applications
|
|
37501
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
37502
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37503
|
+
* @throws {RequiredError}
|
|
37504
|
+
*/
|
|
37505
|
+
async sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
37506
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions);
|
|
37507
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37508
|
+
},
|
|
37509
|
+
}
|
|
37510
|
+
};
|
|
37511
|
+
|
|
37512
|
+
/**
|
|
37513
|
+
* ApplicationDiscoveryBetaApi - factory interface
|
|
37514
|
+
* @export
|
|
37515
|
+
*/
|
|
37516
|
+
export const ApplicationDiscoveryBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
37517
|
+
const localVarFp = ApplicationDiscoveryBetaApiFp(configuration)
|
|
37518
|
+
return {
|
|
37519
|
+
/**
|
|
37520
|
+
* Fetches 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.
|
|
37521
|
+
* @summary Retrieve discovered applications for tenant
|
|
37522
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37523
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37524
|
+
* @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*
|
|
37525
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37526
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37527
|
+
* @throws {RequiredError}
|
|
37528
|
+
*/
|
|
37529
|
+
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>> {
|
|
37530
|
+
return localVarFp.getDiscoveredApplications(limit, offset, filter, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
37531
|
+
},
|
|
37532
|
+
/**
|
|
37533
|
+
* This endpoint allows the user to 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.
|
|
37534
|
+
* @summary CSV template download for discovery
|
|
37535
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37536
|
+
* @throws {RequiredError}
|
|
37537
|
+
*/
|
|
37538
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsTemplateBeta> {
|
|
37539
|
+
return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath));
|
|
37540
|
+
},
|
|
37541
|
+
/**
|
|
37542
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
37543
|
+
* @summary List vendor connector mappings
|
|
37544
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37545
|
+
* @throws {RequiredError}
|
|
37546
|
+
*/
|
|
37547
|
+
getVendorConnectorMappings(axiosOptions?: any): AxiosPromise<Array<VendorConnectorMappingBeta>> {
|
|
37548
|
+
return localVarFp.getVendorConnectorMappings(axiosOptions).then((request) => request(axios, basePath));
|
|
37549
|
+
},
|
|
37550
|
+
/**
|
|
37551
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
37552
|
+
* @summary CSV Upload to discover applications
|
|
37553
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
37554
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37555
|
+
* @throws {RequiredError}
|
|
37556
|
+
*/
|
|
37557
|
+
sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: any): AxiosPromise<void> {
|
|
37558
|
+
return localVarFp.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions).then((request) => request(axios, basePath));
|
|
37559
|
+
},
|
|
37560
|
+
};
|
|
37561
|
+
};
|
|
37562
|
+
|
|
37563
|
+
/**
|
|
37564
|
+
* Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryBetaApi.
|
|
37565
|
+
* @export
|
|
37566
|
+
* @interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest
|
|
37567
|
+
*/
|
|
37568
|
+
export interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest {
|
|
37569
|
+
/**
|
|
37570
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37571
|
+
* @type {number}
|
|
37572
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
37573
|
+
*/
|
|
37574
|
+
readonly limit?: number
|
|
37575
|
+
|
|
37576
|
+
/**
|
|
37577
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37578
|
+
* @type {number}
|
|
37579
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
37580
|
+
*/
|
|
37581
|
+
readonly offset?: number
|
|
37582
|
+
|
|
37583
|
+
/**
|
|
37584
|
+
* Filter results using the standard syntax described in [V3 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*
|
|
37585
|
+
* @type {string}
|
|
37586
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
37587
|
+
*/
|
|
37588
|
+
readonly filter?: string
|
|
37589
|
+
|
|
37590
|
+
/**
|
|
37591
|
+
* Sort results using the standard syntax described in [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**
|
|
37592
|
+
* @type {string}
|
|
37593
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
37594
|
+
*/
|
|
37595
|
+
readonly sorters?: string
|
|
37596
|
+
}
|
|
37597
|
+
|
|
37598
|
+
/**
|
|
37599
|
+
* Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryBetaApi.
|
|
37600
|
+
* @export
|
|
37601
|
+
* @interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest
|
|
37602
|
+
*/
|
|
37603
|
+
export interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest {
|
|
37604
|
+
/**
|
|
37605
|
+
* The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
37606
|
+
* @type {any}
|
|
37607
|
+
* @memberof ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplate
|
|
37608
|
+
*/
|
|
37609
|
+
readonly file: any
|
|
37610
|
+
}
|
|
37611
|
+
|
|
37612
|
+
/**
|
|
37613
|
+
* ApplicationDiscoveryBetaApi - object-oriented interface
|
|
37614
|
+
* @export
|
|
37615
|
+
* @class ApplicationDiscoveryBetaApi
|
|
37616
|
+
* @extends {BaseAPI}
|
|
37617
|
+
*/
|
|
37618
|
+
export class ApplicationDiscoveryBetaApi extends BaseAPI {
|
|
37619
|
+
/**
|
|
37620
|
+
* Fetches 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.
|
|
37621
|
+
* @summary Retrieve discovered applications for tenant
|
|
37622
|
+
* @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters.
|
|
37623
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37624
|
+
* @throws {RequiredError}
|
|
37625
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
37626
|
+
*/
|
|
37627
|
+
public getDiscoveredApplications(requestParameters: ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: AxiosRequestConfig) {
|
|
37628
|
+
return ApplicationDiscoveryBetaApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
37629
|
+
}
|
|
37630
|
+
|
|
37631
|
+
/**
|
|
37632
|
+
* This endpoint allows the user to 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.
|
|
37633
|
+
* @summary CSV template download for discovery
|
|
37634
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37635
|
+
* @throws {RequiredError}
|
|
37636
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
37637
|
+
*/
|
|
37638
|
+
public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig) {
|
|
37639
|
+
return ApplicationDiscoveryBetaApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
37640
|
+
}
|
|
37641
|
+
|
|
37642
|
+
/**
|
|
37643
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
37644
|
+
* @summary List vendor connector mappings
|
|
37645
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37646
|
+
* @throws {RequiredError}
|
|
37647
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
37648
|
+
*/
|
|
37649
|
+
public getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig) {
|
|
37650
|
+
return ApplicationDiscoveryBetaApiFp(this.configuration).getVendorConnectorMappings(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
37651
|
+
}
|
|
37652
|
+
|
|
37653
|
+
/**
|
|
37654
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
37655
|
+
* @summary CSV Upload to discover applications
|
|
37656
|
+
* @param {ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters.
|
|
37657
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37658
|
+
* @throws {RequiredError}
|
|
37659
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
37660
|
+
*/
|
|
37661
|
+
public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: AxiosRequestConfig) {
|
|
37662
|
+
return ApplicationDiscoveryBetaApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
37196
37663
|
}
|
|
37197
37664
|
}
|
|
37198
37665
|
|
|
@@ -37818,7 +38285,7 @@ export class AuthProfileBetaApi extends BaseAPI {
|
|
|
37818
38285
|
export const CertificationCampaignsBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
37819
38286
|
return {
|
|
37820
38287
|
/**
|
|
37821
|
-
* :::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).
|
|
38288
|
+
* :::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.
|
|
37822
38289
|
* @summary Complete a Campaign
|
|
37823
38290
|
* @param {string} id Campaign ID.
|
|
37824
38291
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -37865,7 +38332,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
37865
38332
|
};
|
|
37866
38333
|
},
|
|
37867
38334
|
/**
|
|
37868
|
-
* 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).
|
|
38335
|
+
* 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.
|
|
37869
38336
|
* @summary Create Campaign
|
|
37870
38337
|
* @param {CampaignBeta} campaignBeta
|
|
37871
38338
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37910,7 +38377,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
37910
38377
|
};
|
|
37911
38378
|
},
|
|
37912
38379
|
/**
|
|
37913
|
-
* 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).
|
|
38380
|
+
* 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.
|
|
37914
38381
|
* @summary Create a Campaign Template
|
|
37915
38382
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
37916
38383
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37955,7 +38422,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
37955
38422
|
};
|
|
37956
38423
|
},
|
|
37957
38424
|
/**
|
|
37958
|
-
* 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).
|
|
38425
|
+
* 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.
|
|
37959
38426
|
* @summary Delete a Campaign Template
|
|
37960
38427
|
* @param {string} id ID of the campaign template being deleted.
|
|
37961
38428
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37998,7 +38465,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
37998
38465
|
};
|
|
37999
38466
|
},
|
|
38000
38467
|
/**
|
|
38001
|
-
* 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).
|
|
38468
|
+
* 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.
|
|
38002
38469
|
* @summary Delete Campaign Template Schedule
|
|
38003
38470
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
38004
38471
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38041,7 +38508,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38041
38508
|
};
|
|
38042
38509
|
},
|
|
38043
38510
|
/**
|
|
38044
|
-
* 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).
|
|
38511
|
+
* 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.
|
|
38045
38512
|
* @summary Delete Campaigns
|
|
38046
38513
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
38047
38514
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38086,7 +38553,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38086
38553
|
};
|
|
38087
38554
|
},
|
|
38088
38555
|
/**
|
|
38089
|
-
* 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).
|
|
38556
|
+
* 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.
|
|
38090
38557
|
* @summary List Campaigns
|
|
38091
38558
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
38092
38559
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -38155,7 +38622,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38155
38622
|
};
|
|
38156
38623
|
},
|
|
38157
38624
|
/**
|
|
38158
|
-
* 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).
|
|
38625
|
+
* 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.
|
|
38159
38626
|
* @summary Get Campaign
|
|
38160
38627
|
* @param {string} id ID of the campaign to be retrieved.
|
|
38161
38628
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38198,7 +38665,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38198
38665
|
};
|
|
38199
38666
|
},
|
|
38200
38667
|
/**
|
|
38201
|
-
* 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).
|
|
38668
|
+
* 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.
|
|
38202
38669
|
* @summary Get Campaign Reports
|
|
38203
38670
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
38204
38671
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38241,7 +38708,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38241
38708
|
};
|
|
38242
38709
|
},
|
|
38243
38710
|
/**
|
|
38244
|
-
* 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).
|
|
38711
|
+
* 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.
|
|
38245
38712
|
* @summary Get Campaign Reports Configuration
|
|
38246
38713
|
* @param {*} [axiosOptions] Override http request option.
|
|
38247
38714
|
* @deprecated
|
|
@@ -38280,7 +38747,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38280
38747
|
};
|
|
38281
38748
|
},
|
|
38282
38749
|
/**
|
|
38283
|
-
* 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).
|
|
38750
|
+
* 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.
|
|
38284
38751
|
* @summary Get a Campaign Template
|
|
38285
38752
|
* @param {string} id Requested campaign template\'s ID.
|
|
38286
38753
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38323,7 +38790,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38323
38790
|
};
|
|
38324
38791
|
},
|
|
38325
38792
|
/**
|
|
38326
|
-
* 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).
|
|
38793
|
+
* 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.
|
|
38327
38794
|
* @summary Get Campaign Template Schedule
|
|
38328
38795
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
38329
38796
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38366,7 +38833,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38366
38833
|
};
|
|
38367
38834
|
},
|
|
38368
38835
|
/**
|
|
38369
|
-
* 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/v3/list-campaign-templates).
|
|
38836
|
+
* 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/v3/list-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.
|
|
38370
38837
|
* @summary List Campaign Templates
|
|
38371
38838
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
38372
38839
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -38430,7 +38897,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38430
38897
|
};
|
|
38431
38898
|
},
|
|
38432
38899
|
/**
|
|
38433
|
-
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
38900
|
+
* 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.
|
|
38434
38901
|
* @summary Reassign Certifications
|
|
38435
38902
|
* @param {string} id The certification campaign ID
|
|
38436
38903
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -38479,7 +38946,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38479
38946
|
};
|
|
38480
38947
|
},
|
|
38481
38948
|
/**
|
|
38482
|
-
* 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).
|
|
38949
|
+
* 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.
|
|
38483
38950
|
* @summary Update a Campaign Template
|
|
38484
38951
|
* @param {string} id ID of the campaign template being modified.
|
|
38485
38952
|
* @param {Array<JsonPatchOperationBeta>} 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)
|
|
@@ -38528,7 +38995,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38528
38995
|
};
|
|
38529
38996
|
},
|
|
38530
38997
|
/**
|
|
38531
|
-
* 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).
|
|
38998
|
+
* 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.
|
|
38532
38999
|
* @summary Set Campaign Reports Configuration
|
|
38533
39000
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
38534
39001
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38573,7 +39040,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38573
39040
|
};
|
|
38574
39041
|
},
|
|
38575
39042
|
/**
|
|
38576
|
-
* 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).
|
|
39043
|
+
* 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.
|
|
38577
39044
|
* @summary Set Campaign Template Schedule
|
|
38578
39045
|
* @param {string} id ID of the campaign template being scheduled.
|
|
38579
39046
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -38620,7 +39087,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38620
39087
|
};
|
|
38621
39088
|
},
|
|
38622
39089
|
/**
|
|
38623
|
-
* 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).
|
|
39090
|
+
* 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.
|
|
38624
39091
|
* @summary Activate a Campaign
|
|
38625
39092
|
* @param {string} id Campaign ID.
|
|
38626
39093
|
* @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.
|
|
@@ -38667,7 +39134,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38667
39134
|
};
|
|
38668
39135
|
},
|
|
38669
39136
|
/**
|
|
38670
|
-
* 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).
|
|
39137
|
+
* 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.
|
|
38671
39138
|
* @summary Run Campaign Remediation Scan
|
|
38672
39139
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
38673
39140
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38710,7 +39177,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38710
39177
|
};
|
|
38711
39178
|
},
|
|
38712
39179
|
/**
|
|
38713
|
-
* 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).
|
|
39180
|
+
* 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.
|
|
38714
39181
|
* @summary Run Campaign Report
|
|
38715
39182
|
* @param {string} id ID of the campaign the report is being run for.
|
|
38716
39183
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -38757,7 +39224,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38757
39224
|
};
|
|
38758
39225
|
},
|
|
38759
39226
|
/**
|
|
38760
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
39227
|
+
* 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.
|
|
38761
39228
|
* @summary Generate a Campaign from Template
|
|
38762
39229
|
* @param {string} id ID of the campaign template to use for generation.
|
|
38763
39230
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38800,7 +39267,7 @@ export const CertificationCampaignsBetaApiAxiosParamCreator = function (configur
|
|
|
38800
39267
|
};
|
|
38801
39268
|
},
|
|
38802
39269
|
/**
|
|
38803
|
-
* 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/beta/update-campaign).
|
|
39270
|
+
* 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/beta/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
38804
39271
|
* @summary Update a Campaign
|
|
38805
39272
|
* @param {string} id ID of the campaign template being modified.
|
|
38806
39273
|
* @param {Array<object>} 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
|
|
@@ -38859,7 +39326,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38859
39326
|
const localVarAxiosParamCreator = CertificationCampaignsBetaApiAxiosParamCreator(configuration)
|
|
38860
39327
|
return {
|
|
38861
39328
|
/**
|
|
38862
|
-
* :::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).
|
|
39329
|
+
* :::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.
|
|
38863
39330
|
* @summary Complete a Campaign
|
|
38864
39331
|
* @param {string} id Campaign ID.
|
|
38865
39332
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -38872,7 +39339,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38872
39339
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38873
39340
|
},
|
|
38874
39341
|
/**
|
|
38875
|
-
* 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).
|
|
39342
|
+
* 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.
|
|
38876
39343
|
* @summary Create Campaign
|
|
38877
39344
|
* @param {CampaignBeta} campaignBeta
|
|
38878
39345
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38884,7 +39351,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38884
39351
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38885
39352
|
},
|
|
38886
39353
|
/**
|
|
38887
|
-
* 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).
|
|
39354
|
+
* 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.
|
|
38888
39355
|
* @summary Create a Campaign Template
|
|
38889
39356
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
38890
39357
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38896,7 +39363,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38896
39363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38897
39364
|
},
|
|
38898
39365
|
/**
|
|
38899
|
-
* 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).
|
|
39366
|
+
* 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.
|
|
38900
39367
|
* @summary Delete a Campaign Template
|
|
38901
39368
|
* @param {string} id ID of the campaign template being deleted.
|
|
38902
39369
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38908,7 +39375,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38908
39375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38909
39376
|
},
|
|
38910
39377
|
/**
|
|
38911
|
-
* 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).
|
|
39378
|
+
* 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.
|
|
38912
39379
|
* @summary Delete Campaign Template Schedule
|
|
38913
39380
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
38914
39381
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38920,7 +39387,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38920
39387
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38921
39388
|
},
|
|
38922
39389
|
/**
|
|
38923
|
-
* 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).
|
|
39390
|
+
* 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.
|
|
38924
39391
|
* @summary Delete Campaigns
|
|
38925
39392
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
38926
39393
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38932,7 +39399,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38932
39399
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38933
39400
|
},
|
|
38934
39401
|
/**
|
|
38935
|
-
* 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).
|
|
39402
|
+
* 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.
|
|
38936
39403
|
* @summary List Campaigns
|
|
38937
39404
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
38938
39405
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -38949,7 +39416,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38949
39416
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38950
39417
|
},
|
|
38951
39418
|
/**
|
|
38952
|
-
* 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).
|
|
39419
|
+
* 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.
|
|
38953
39420
|
* @summary Get Campaign
|
|
38954
39421
|
* @param {string} id ID of the campaign to be retrieved.
|
|
38955
39422
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38961,7 +39428,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38961
39428
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38962
39429
|
},
|
|
38963
39430
|
/**
|
|
38964
|
-
* 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).
|
|
39431
|
+
* 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.
|
|
38965
39432
|
* @summary Get Campaign Reports
|
|
38966
39433
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
38967
39434
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38973,7 +39440,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38973
39440
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38974
39441
|
},
|
|
38975
39442
|
/**
|
|
38976
|
-
* 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).
|
|
39443
|
+
* 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.
|
|
38977
39444
|
* @summary Get Campaign Reports Configuration
|
|
38978
39445
|
* @param {*} [axiosOptions] Override http request option.
|
|
38979
39446
|
* @deprecated
|
|
@@ -38984,7 +39451,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38984
39451
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38985
39452
|
},
|
|
38986
39453
|
/**
|
|
38987
|
-
* 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).
|
|
39454
|
+
* 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.
|
|
38988
39455
|
* @summary Get a Campaign Template
|
|
38989
39456
|
* @param {string} id Requested campaign template\'s ID.
|
|
38990
39457
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38996,7 +39463,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
38996
39463
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38997
39464
|
},
|
|
38998
39465
|
/**
|
|
38999
|
-
* 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).
|
|
39466
|
+
* 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.
|
|
39000
39467
|
* @summary Get Campaign Template Schedule
|
|
39001
39468
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
39002
39469
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39008,7 +39475,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39008
39475
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39009
39476
|
},
|
|
39010
39477
|
/**
|
|
39011
|
-
* 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/v3/list-campaign-templates).
|
|
39478
|
+
* 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/v3/list-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.
|
|
39012
39479
|
* @summary List Campaign Templates
|
|
39013
39480
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
39014
39481
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -39024,7 +39491,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39024
39491
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39025
39492
|
},
|
|
39026
39493
|
/**
|
|
39027
|
-
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
39494
|
+
* 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.
|
|
39028
39495
|
* @summary Reassign Certifications
|
|
39029
39496
|
* @param {string} id The certification campaign ID
|
|
39030
39497
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -39037,7 +39504,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39037
39504
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39038
39505
|
},
|
|
39039
39506
|
/**
|
|
39040
|
-
* 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).
|
|
39507
|
+
* 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.
|
|
39041
39508
|
* @summary Update a Campaign Template
|
|
39042
39509
|
* @param {string} id ID of the campaign template being modified.
|
|
39043
39510
|
* @param {Array<JsonPatchOperationBeta>} 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)
|
|
@@ -39050,7 +39517,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39050
39517
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39051
39518
|
},
|
|
39052
39519
|
/**
|
|
39053
|
-
* 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).
|
|
39520
|
+
* 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.
|
|
39054
39521
|
* @summary Set Campaign Reports Configuration
|
|
39055
39522
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
39056
39523
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39062,7 +39529,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39062
39529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39063
39530
|
},
|
|
39064
39531
|
/**
|
|
39065
|
-
* 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).
|
|
39532
|
+
* 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.
|
|
39066
39533
|
* @summary Set Campaign Template Schedule
|
|
39067
39534
|
* @param {string} id ID of the campaign template being scheduled.
|
|
39068
39535
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -39075,7 +39542,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39075
39542
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39076
39543
|
},
|
|
39077
39544
|
/**
|
|
39078
|
-
* 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).
|
|
39545
|
+
* 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.
|
|
39079
39546
|
* @summary Activate a Campaign
|
|
39080
39547
|
* @param {string} id Campaign ID.
|
|
39081
39548
|
* @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.
|
|
@@ -39088,7 +39555,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39088
39555
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39089
39556
|
},
|
|
39090
39557
|
/**
|
|
39091
|
-
* 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).
|
|
39558
|
+
* 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.
|
|
39092
39559
|
* @summary Run Campaign Remediation Scan
|
|
39093
39560
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
39094
39561
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39100,7 +39567,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39100
39567
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39101
39568
|
},
|
|
39102
39569
|
/**
|
|
39103
|
-
* 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).
|
|
39570
|
+
* 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.
|
|
39104
39571
|
* @summary Run Campaign Report
|
|
39105
39572
|
* @param {string} id ID of the campaign the report is being run for.
|
|
39106
39573
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -39113,7 +39580,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39113
39580
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39114
39581
|
},
|
|
39115
39582
|
/**
|
|
39116
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
39583
|
+
* 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.
|
|
39117
39584
|
* @summary Generate a Campaign from Template
|
|
39118
39585
|
* @param {string} id ID of the campaign template to use for generation.
|
|
39119
39586
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39125,7 +39592,7 @@ export const CertificationCampaignsBetaApiFp = function(configuration?: Configur
|
|
|
39125
39592
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39126
39593
|
},
|
|
39127
39594
|
/**
|
|
39128
|
-
* 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/beta/update-campaign).
|
|
39595
|
+
* 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/beta/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
39129
39596
|
* @summary Update a Campaign
|
|
39130
39597
|
* @param {string} id ID of the campaign template being modified.
|
|
39131
39598
|
* @param {Array<object>} 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
|
|
@@ -39148,7 +39615,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39148
39615
|
const localVarFp = CertificationCampaignsBetaApiFp(configuration)
|
|
39149
39616
|
return {
|
|
39150
39617
|
/**
|
|
39151
|
-
* :::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).
|
|
39618
|
+
* :::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.
|
|
39152
39619
|
* @summary Complete a Campaign
|
|
39153
39620
|
* @param {string} id Campaign ID.
|
|
39154
39621
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -39160,7 +39627,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39160
39627
|
return localVarFp.completeCampaign(id, completeCampaignOptionsBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39161
39628
|
},
|
|
39162
39629
|
/**
|
|
39163
|
-
* 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).
|
|
39630
|
+
* 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.
|
|
39164
39631
|
* @summary Create Campaign
|
|
39165
39632
|
* @param {CampaignBeta} campaignBeta
|
|
39166
39633
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39171,7 +39638,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39171
39638
|
return localVarFp.createCampaign(campaignBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39172
39639
|
},
|
|
39173
39640
|
/**
|
|
39174
|
-
* 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).
|
|
39641
|
+
* 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.
|
|
39175
39642
|
* @summary Create a Campaign Template
|
|
39176
39643
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
39177
39644
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39182,7 +39649,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39182
39649
|
return localVarFp.createCampaignTemplate(campaignTemplateBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39183
39650
|
},
|
|
39184
39651
|
/**
|
|
39185
|
-
* 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).
|
|
39652
|
+
* 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.
|
|
39186
39653
|
* @summary Delete a Campaign Template
|
|
39187
39654
|
* @param {string} id ID of the campaign template being deleted.
|
|
39188
39655
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39193,7 +39660,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39193
39660
|
return localVarFp.deleteCampaignTemplate(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39194
39661
|
},
|
|
39195
39662
|
/**
|
|
39196
|
-
* 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).
|
|
39663
|
+
* 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.
|
|
39197
39664
|
* @summary Delete Campaign Template Schedule
|
|
39198
39665
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
39199
39666
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39204,7 +39671,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39204
39671
|
return localVarFp.deleteCampaignTemplateSchedule(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39205
39672
|
},
|
|
39206
39673
|
/**
|
|
39207
|
-
* 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).
|
|
39674
|
+
* 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.
|
|
39208
39675
|
* @summary Delete Campaigns
|
|
39209
39676
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
39210
39677
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39215,7 +39682,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39215
39682
|
return localVarFp.deleteCampaigns(deleteCampaignsRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39216
39683
|
},
|
|
39217
39684
|
/**
|
|
39218
|
-
* 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).
|
|
39685
|
+
* 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.
|
|
39219
39686
|
* @summary List Campaigns
|
|
39220
39687
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
39221
39688
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -39231,7 +39698,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39231
39698
|
return localVarFp.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
39232
39699
|
},
|
|
39233
39700
|
/**
|
|
39234
|
-
* 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).
|
|
39701
|
+
* 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.
|
|
39235
39702
|
* @summary Get Campaign
|
|
39236
39703
|
* @param {string} id ID of the campaign to be retrieved.
|
|
39237
39704
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39242,7 +39709,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39242
39709
|
return localVarFp.getCampaign(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39243
39710
|
},
|
|
39244
39711
|
/**
|
|
39245
|
-
* 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).
|
|
39712
|
+
* 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.
|
|
39246
39713
|
* @summary Get Campaign Reports
|
|
39247
39714
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
39248
39715
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39253,7 +39720,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39253
39720
|
return localVarFp.getCampaignReports(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39254
39721
|
},
|
|
39255
39722
|
/**
|
|
39256
|
-
* 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).
|
|
39723
|
+
* 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.
|
|
39257
39724
|
* @summary Get Campaign Reports Configuration
|
|
39258
39725
|
* @param {*} [axiosOptions] Override http request option.
|
|
39259
39726
|
* @deprecated
|
|
@@ -39263,7 +39730,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39263
39730
|
return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath));
|
|
39264
39731
|
},
|
|
39265
39732
|
/**
|
|
39266
|
-
* 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).
|
|
39733
|
+
* 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.
|
|
39267
39734
|
* @summary Get a Campaign Template
|
|
39268
39735
|
* @param {string} id Requested campaign template\'s ID.
|
|
39269
39736
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39274,7 +39741,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39274
39741
|
return localVarFp.getCampaignTemplate(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39275
39742
|
},
|
|
39276
39743
|
/**
|
|
39277
|
-
* 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).
|
|
39744
|
+
* 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.
|
|
39278
39745
|
* @summary Get Campaign Template Schedule
|
|
39279
39746
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
39280
39747
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39285,7 +39752,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39285
39752
|
return localVarFp.getCampaignTemplateSchedule(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39286
39753
|
},
|
|
39287
39754
|
/**
|
|
39288
|
-
* 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/v3/list-campaign-templates).
|
|
39755
|
+
* 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/v3/list-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.
|
|
39289
39756
|
* @summary List Campaign Templates
|
|
39290
39757
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
39291
39758
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -39300,7 +39767,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39300
39767
|
return localVarFp.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions).then((request) => request(axios, basePath));
|
|
39301
39768
|
},
|
|
39302
39769
|
/**
|
|
39303
|
-
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
39770
|
+
* 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.
|
|
39304
39771
|
* @summary Reassign Certifications
|
|
39305
39772
|
* @param {string} id The certification campaign ID
|
|
39306
39773
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -39312,7 +39779,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39312
39779
|
return localVarFp.move(id, adminReviewReassignBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39313
39780
|
},
|
|
39314
39781
|
/**
|
|
39315
|
-
* 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).
|
|
39782
|
+
* 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.
|
|
39316
39783
|
* @summary Update a Campaign Template
|
|
39317
39784
|
* @param {string} id ID of the campaign template being modified.
|
|
39318
39785
|
* @param {Array<JsonPatchOperationBeta>} 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)
|
|
@@ -39324,7 +39791,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39324
39791
|
return localVarFp.patchCampaignTemplate(id, jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39325
39792
|
},
|
|
39326
39793
|
/**
|
|
39327
|
-
* 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).
|
|
39794
|
+
* 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.
|
|
39328
39795
|
* @summary Set Campaign Reports Configuration
|
|
39329
39796
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
39330
39797
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39335,7 +39802,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39335
39802
|
return localVarFp.setCampaignReportsConfig(campaignReportsConfigBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39336
39803
|
},
|
|
39337
39804
|
/**
|
|
39338
|
-
* 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).
|
|
39805
|
+
* 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.
|
|
39339
39806
|
* @summary Set Campaign Template Schedule
|
|
39340
39807
|
* @param {string} id ID of the campaign template being scheduled.
|
|
39341
39808
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -39347,7 +39814,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39347
39814
|
return localVarFp.setCampaignTemplateSchedule(id, scheduleBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39348
39815
|
},
|
|
39349
39816
|
/**
|
|
39350
|
-
* 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).
|
|
39817
|
+
* 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.
|
|
39351
39818
|
* @summary Activate a Campaign
|
|
39352
39819
|
* @param {string} id Campaign ID.
|
|
39353
39820
|
* @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.
|
|
@@ -39359,7 +39826,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39359
39826
|
return localVarFp.startCampaign(id, activateCampaignOptionsBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
39360
39827
|
},
|
|
39361
39828
|
/**
|
|
39362
|
-
* 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).
|
|
39829
|
+
* 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.
|
|
39363
39830
|
* @summary Run Campaign Remediation Scan
|
|
39364
39831
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
39365
39832
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39370,7 +39837,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39370
39837
|
return localVarFp.startCampaignRemediationScan(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39371
39838
|
},
|
|
39372
39839
|
/**
|
|
39373
|
-
* 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).
|
|
39840
|
+
* 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.
|
|
39374
39841
|
* @summary Run Campaign Report
|
|
39375
39842
|
* @param {string} id ID of the campaign the report is being run for.
|
|
39376
39843
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -39382,7 +39849,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39382
39849
|
return localVarFp.startCampaignReport(id, type, axiosOptions).then((request) => request(axios, basePath));
|
|
39383
39850
|
},
|
|
39384
39851
|
/**
|
|
39385
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
39852
|
+
* 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.
|
|
39386
39853
|
* @summary Generate a Campaign from Template
|
|
39387
39854
|
* @param {string} id ID of the campaign template to use for generation.
|
|
39388
39855
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39393,7 +39860,7 @@ export const CertificationCampaignsBetaApiFactory = function (configuration?: Co
|
|
|
39393
39860
|
return localVarFp.startGenerateCampaignTemplate(id, axiosOptions).then((request) => request(axios, basePath));
|
|
39394
39861
|
},
|
|
39395
39862
|
/**
|
|
39396
|
-
* 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/beta/update-campaign).
|
|
39863
|
+
* 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/beta/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
39397
39864
|
* @summary Update a Campaign
|
|
39398
39865
|
* @param {string} id ID of the campaign template being modified.
|
|
39399
39866
|
* @param {Array<object>} 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
|
|
@@ -39821,7 +40288,7 @@ export interface CertificationCampaignsBetaApiUpdateCampaignRequest {
|
|
|
39821
40288
|
*/
|
|
39822
40289
|
export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
39823
40290
|
/**
|
|
39824
|
-
* :::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).
|
|
40291
|
+
* :::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.
|
|
39825
40292
|
* @summary Complete a Campaign
|
|
39826
40293
|
* @param {CertificationCampaignsBetaApiCompleteCampaignRequest} requestParameters Request parameters.
|
|
39827
40294
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39834,7 +40301,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39834
40301
|
}
|
|
39835
40302
|
|
|
39836
40303
|
/**
|
|
39837
|
-
* 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).
|
|
40304
|
+
* 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.
|
|
39838
40305
|
* @summary Create Campaign
|
|
39839
40306
|
* @param {CertificationCampaignsBetaApiCreateCampaignRequest} requestParameters Request parameters.
|
|
39840
40307
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39847,7 +40314,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39847
40314
|
}
|
|
39848
40315
|
|
|
39849
40316
|
/**
|
|
39850
|
-
* 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).
|
|
40317
|
+
* 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.
|
|
39851
40318
|
* @summary Create a Campaign Template
|
|
39852
40319
|
* @param {CertificationCampaignsBetaApiCreateCampaignTemplateRequest} requestParameters Request parameters.
|
|
39853
40320
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39860,7 +40327,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39860
40327
|
}
|
|
39861
40328
|
|
|
39862
40329
|
/**
|
|
39863
|
-
* 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).
|
|
40330
|
+
* 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.
|
|
39864
40331
|
* @summary Delete a Campaign Template
|
|
39865
40332
|
* @param {CertificationCampaignsBetaApiDeleteCampaignTemplateRequest} requestParameters Request parameters.
|
|
39866
40333
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39873,7 +40340,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39873
40340
|
}
|
|
39874
40341
|
|
|
39875
40342
|
/**
|
|
39876
|
-
* 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).
|
|
40343
|
+
* 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.
|
|
39877
40344
|
* @summary Delete Campaign Template Schedule
|
|
39878
40345
|
* @param {CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
39879
40346
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39886,7 +40353,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39886
40353
|
}
|
|
39887
40354
|
|
|
39888
40355
|
/**
|
|
39889
|
-
* 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).
|
|
40356
|
+
* 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.
|
|
39890
40357
|
* @summary Delete Campaigns
|
|
39891
40358
|
* @param {CertificationCampaignsBetaApiDeleteCampaignsRequest} requestParameters Request parameters.
|
|
39892
40359
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39899,7 +40366,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39899
40366
|
}
|
|
39900
40367
|
|
|
39901
40368
|
/**
|
|
39902
|
-
* 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).
|
|
40369
|
+
* 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.
|
|
39903
40370
|
* @summary List Campaigns
|
|
39904
40371
|
* @param {CertificationCampaignsBetaApiGetActiveCampaignsRequest} requestParameters Request parameters.
|
|
39905
40372
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39912,7 +40379,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39912
40379
|
}
|
|
39913
40380
|
|
|
39914
40381
|
/**
|
|
39915
|
-
* 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).
|
|
40382
|
+
* 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.
|
|
39916
40383
|
* @summary Get Campaign
|
|
39917
40384
|
* @param {CertificationCampaignsBetaApiGetCampaignRequest} requestParameters Request parameters.
|
|
39918
40385
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39925,7 +40392,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39925
40392
|
}
|
|
39926
40393
|
|
|
39927
40394
|
/**
|
|
39928
|
-
* 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).
|
|
40395
|
+
* 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.
|
|
39929
40396
|
* @summary Get Campaign Reports
|
|
39930
40397
|
* @param {CertificationCampaignsBetaApiGetCampaignReportsRequest} requestParameters Request parameters.
|
|
39931
40398
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39938,7 +40405,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39938
40405
|
}
|
|
39939
40406
|
|
|
39940
40407
|
/**
|
|
39941
|
-
* 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).
|
|
40408
|
+
* 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.
|
|
39942
40409
|
* @summary Get Campaign Reports Configuration
|
|
39943
40410
|
* @param {*} [axiosOptions] Override http request option.
|
|
39944
40411
|
* @deprecated
|
|
@@ -39950,7 +40417,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39950
40417
|
}
|
|
39951
40418
|
|
|
39952
40419
|
/**
|
|
39953
|
-
* 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).
|
|
40420
|
+
* 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.
|
|
39954
40421
|
* @summary Get a Campaign Template
|
|
39955
40422
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplateRequest} requestParameters Request parameters.
|
|
39956
40423
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39963,7 +40430,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39963
40430
|
}
|
|
39964
40431
|
|
|
39965
40432
|
/**
|
|
39966
|
-
* 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).
|
|
40433
|
+
* 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.
|
|
39967
40434
|
* @summary Get Campaign Template Schedule
|
|
39968
40435
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
39969
40436
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39976,7 +40443,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39976
40443
|
}
|
|
39977
40444
|
|
|
39978
40445
|
/**
|
|
39979
|
-
* 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/v3/list-campaign-templates).
|
|
40446
|
+
* 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/v3/list-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.
|
|
39980
40447
|
* @summary List Campaign Templates
|
|
39981
40448
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplatesRequest} requestParameters Request parameters.
|
|
39982
40449
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39989,7 +40456,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
39989
40456
|
}
|
|
39990
40457
|
|
|
39991
40458
|
/**
|
|
39992
|
-
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
40459
|
+
* 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.
|
|
39993
40460
|
* @summary Reassign Certifications
|
|
39994
40461
|
* @param {CertificationCampaignsBetaApiMoveRequest} requestParameters Request parameters.
|
|
39995
40462
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40002,7 +40469,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40002
40469
|
}
|
|
40003
40470
|
|
|
40004
40471
|
/**
|
|
40005
|
-
* 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).
|
|
40472
|
+
* 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.
|
|
40006
40473
|
* @summary Update a Campaign Template
|
|
40007
40474
|
* @param {CertificationCampaignsBetaApiPatchCampaignTemplateRequest} requestParameters Request parameters.
|
|
40008
40475
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40015,7 +40482,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40015
40482
|
}
|
|
40016
40483
|
|
|
40017
40484
|
/**
|
|
40018
|
-
* 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).
|
|
40485
|
+
* 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.
|
|
40019
40486
|
* @summary Set Campaign Reports Configuration
|
|
40020
40487
|
* @param {CertificationCampaignsBetaApiSetCampaignReportsConfigRequest} requestParameters Request parameters.
|
|
40021
40488
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40028,7 +40495,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40028
40495
|
}
|
|
40029
40496
|
|
|
40030
40497
|
/**
|
|
40031
|
-
* 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).
|
|
40498
|
+
* 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.
|
|
40032
40499
|
* @summary Set Campaign Template Schedule
|
|
40033
40500
|
* @param {CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
40034
40501
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40041,7 +40508,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40041
40508
|
}
|
|
40042
40509
|
|
|
40043
40510
|
/**
|
|
40044
|
-
* 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).
|
|
40511
|
+
* 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.
|
|
40045
40512
|
* @summary Activate a Campaign
|
|
40046
40513
|
* @param {CertificationCampaignsBetaApiStartCampaignRequest} requestParameters Request parameters.
|
|
40047
40514
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40054,7 +40521,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40054
40521
|
}
|
|
40055
40522
|
|
|
40056
40523
|
/**
|
|
40057
|
-
* 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).
|
|
40524
|
+
* 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.
|
|
40058
40525
|
* @summary Run Campaign Remediation Scan
|
|
40059
40526
|
* @param {CertificationCampaignsBetaApiStartCampaignRemediationScanRequest} requestParameters Request parameters.
|
|
40060
40527
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40067,7 +40534,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40067
40534
|
}
|
|
40068
40535
|
|
|
40069
40536
|
/**
|
|
40070
|
-
* 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).
|
|
40537
|
+
* 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.
|
|
40071
40538
|
* @summary Run Campaign Report
|
|
40072
40539
|
* @param {CertificationCampaignsBetaApiStartCampaignReportRequest} requestParameters Request parameters.
|
|
40073
40540
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40080,7 +40547,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40080
40547
|
}
|
|
40081
40548
|
|
|
40082
40549
|
/**
|
|
40083
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
40550
|
+
* 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.
|
|
40084
40551
|
* @summary Generate a Campaign from Template
|
|
40085
40552
|
* @param {CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters.
|
|
40086
40553
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40093,7 +40560,7 @@ export class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
40093
40560
|
}
|
|
40094
40561
|
|
|
40095
40562
|
/**
|
|
40096
|
-
* 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/beta/update-campaign).
|
|
40563
|
+
* 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/beta/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
40097
40564
|
* @summary Update a Campaign
|
|
40098
40565
|
* @param {CertificationCampaignsBetaApiUpdateCampaignRequest} requestParameters Request parameters.
|
|
40099
40566
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41557,6 +42024,48 @@ export const CustomFormsBetaApiAxiosParamCreator = function (configuration?: Con
|
|
|
41557
42024
|
|
|
41558
42025
|
|
|
41559
42026
|
|
|
42027
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
42028
|
+
|
|
42029
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42030
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42031
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
42032
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createFormDefinitionRequestBeta, localVarRequestOptions, configuration)
|
|
42033
|
+
|
|
42034
|
+
return {
|
|
42035
|
+
url: toPathString(localVarUrlObj),
|
|
42036
|
+
axiosOptions: localVarRequestOptions,
|
|
42037
|
+
};
|
|
42038
|
+
},
|
|
42039
|
+
/**
|
|
42040
|
+
*
|
|
42041
|
+
* @summary Create a form definition by template.
|
|
42042
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
42043
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42044
|
+
* @throws {RequiredError}
|
|
42045
|
+
*/
|
|
42046
|
+
createFormDefinitionByTemplate: async (createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42047
|
+
const localVarPath = `/form-definitions/template`;
|
|
42048
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42049
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42050
|
+
let baseOptions;
|
|
42051
|
+
if (configuration) {
|
|
42052
|
+
baseOptions = configuration.baseOptions;
|
|
42053
|
+
}
|
|
42054
|
+
|
|
42055
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
42056
|
+
const localVarHeaderParameter = {} as any;
|
|
42057
|
+
const localVarQueryParameter = {} as any;
|
|
42058
|
+
|
|
42059
|
+
// authentication UserContextAuth required
|
|
42060
|
+
// oauth required
|
|
42061
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
42062
|
+
|
|
42063
|
+
// authentication UserContextAuth required
|
|
42064
|
+
// oauth required
|
|
42065
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
42066
|
+
|
|
42067
|
+
|
|
42068
|
+
|
|
41560
42069
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41561
42070
|
|
|
41562
42071
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -42393,6 +42902,17 @@ export const CustomFormsBetaApiFp = function(configuration?: Configuration) {
|
|
|
42393
42902
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinition(createFormDefinitionRequestBeta, axiosOptions);
|
|
42394
42903
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42395
42904
|
},
|
|
42905
|
+
/**
|
|
42906
|
+
*
|
|
42907
|
+
* @summary Create a form definition by template.
|
|
42908
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
42909
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42910
|
+
* @throws {RequiredError}
|
|
42911
|
+
*/
|
|
42912
|
+
async createFormDefinitionByTemplate(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormDefinitionResponseBeta>> {
|
|
42913
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionByTemplate(createFormDefinitionRequestBeta, axiosOptions);
|
|
42914
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42915
|
+
},
|
|
42396
42916
|
/**
|
|
42397
42917
|
*
|
|
42398
42918
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -42617,6 +43137,16 @@ export const CustomFormsBetaApiFactory = function (configuration?: Configuration
|
|
|
42617
43137
|
createFormDefinition(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: any): AxiosPromise<FormDefinitionResponseBeta> {
|
|
42618
43138
|
return localVarFp.createFormDefinition(createFormDefinitionRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
42619
43139
|
},
|
|
43140
|
+
/**
|
|
43141
|
+
*
|
|
43142
|
+
* @summary Create a form definition by template.
|
|
43143
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
43144
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
43145
|
+
* @throws {RequiredError}
|
|
43146
|
+
*/
|
|
43147
|
+
createFormDefinitionByTemplate(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: any): AxiosPromise<FormDefinitionResponseBeta> {
|
|
43148
|
+
return localVarFp.createFormDefinitionByTemplate(createFormDefinitionRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
43149
|
+
},
|
|
42620
43150
|
/**
|
|
42621
43151
|
*
|
|
42622
43152
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -42821,6 +43351,20 @@ export interface CustomFormsBetaApiCreateFormDefinitionRequest {
|
|
|
42821
43351
|
readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta
|
|
42822
43352
|
}
|
|
42823
43353
|
|
|
43354
|
+
/**
|
|
43355
|
+
* Request parameters for createFormDefinitionByTemplate operation in CustomFormsBetaApi.
|
|
43356
|
+
* @export
|
|
43357
|
+
* @interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest
|
|
43358
|
+
*/
|
|
43359
|
+
export interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest {
|
|
43360
|
+
/**
|
|
43361
|
+
* Body is the request payload to create form definition request
|
|
43362
|
+
* @type {CreateFormDefinitionRequestBeta}
|
|
43363
|
+
* @memberof CustomFormsBetaApiCreateFormDefinitionByTemplate
|
|
43364
|
+
*/
|
|
43365
|
+
readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta
|
|
43366
|
+
}
|
|
43367
|
+
|
|
42824
43368
|
/**
|
|
42825
43369
|
* Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsBetaApi.
|
|
42826
43370
|
* @export
|
|
@@ -43183,6 +43727,18 @@ export class CustomFormsBetaApi extends BaseAPI {
|
|
|
43183
43727
|
return CustomFormsBetaApiFp(this.configuration).createFormDefinition(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
43184
43728
|
}
|
|
43185
43729
|
|
|
43730
|
+
/**
|
|
43731
|
+
*
|
|
43732
|
+
* @summary Create a form definition by template.
|
|
43733
|
+
* @param {CustomFormsBetaApiCreateFormDefinitionByTemplateRequest} requestParameters Request parameters.
|
|
43734
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
43735
|
+
* @throws {RequiredError}
|
|
43736
|
+
* @memberof CustomFormsBetaApi
|
|
43737
|
+
*/
|
|
43738
|
+
public createFormDefinitionByTemplate(requestParameters: CustomFormsBetaApiCreateFormDefinitionByTemplateRequest = {}, axiosOptions?: AxiosRequestConfig) {
|
|
43739
|
+
return CustomFormsBetaApiFp(this.configuration).createFormDefinitionByTemplate(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
43740
|
+
}
|
|
43741
|
+
|
|
43186
43742
|
/**
|
|
43187
43743
|
*
|
|
43188
43744
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -43722,176 +44278,6 @@ export class CustomPasswordInstructionsBetaApi extends BaseAPI {
|
|
|
43722
44278
|
}
|
|
43723
44279
|
|
|
43724
44280
|
|
|
43725
|
-
/**
|
|
43726
|
-
* DiscoveredApplicationsBetaApi - axios parameter creator
|
|
43727
|
-
* @export
|
|
43728
|
-
*/
|
|
43729
|
-
export const DiscoveredApplicationsBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
43730
|
-
return {
|
|
43731
|
-
/**
|
|
43732
|
-
* Fetches 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.
|
|
43733
|
-
* @summary Retrieve discovered applications for tenant
|
|
43734
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43735
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43736
|
-
* @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*
|
|
43737
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
43738
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
43739
|
-
* @throws {RequiredError}
|
|
43740
|
-
*/
|
|
43741
|
-
getDiscoveredApplications: async (limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43742
|
-
const localVarPath = `/discovered-applications`;
|
|
43743
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43744
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43745
|
-
let baseOptions;
|
|
43746
|
-
if (configuration) {
|
|
43747
|
-
baseOptions = configuration.baseOptions;
|
|
43748
|
-
}
|
|
43749
|
-
|
|
43750
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
43751
|
-
const localVarHeaderParameter = {} as any;
|
|
43752
|
-
const localVarQueryParameter = {} as any;
|
|
43753
|
-
|
|
43754
|
-
// authentication UserContextAuth required
|
|
43755
|
-
// oauth required
|
|
43756
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
43757
|
-
|
|
43758
|
-
// authentication UserContextAuth required
|
|
43759
|
-
// oauth required
|
|
43760
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
43761
|
-
|
|
43762
|
-
if (limit !== undefined) {
|
|
43763
|
-
localVarQueryParameter['limit'] = limit;
|
|
43764
|
-
}
|
|
43765
|
-
|
|
43766
|
-
if (offset !== undefined) {
|
|
43767
|
-
localVarQueryParameter['offset'] = offset;
|
|
43768
|
-
}
|
|
43769
|
-
|
|
43770
|
-
if (filter !== undefined) {
|
|
43771
|
-
localVarQueryParameter['filter'] = filter;
|
|
43772
|
-
}
|
|
43773
|
-
|
|
43774
|
-
if (sorters !== undefined) {
|
|
43775
|
-
localVarQueryParameter['sorters'] = sorters;
|
|
43776
|
-
}
|
|
43777
|
-
|
|
43778
|
-
|
|
43779
|
-
|
|
43780
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43781
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43782
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
43783
|
-
|
|
43784
|
-
return {
|
|
43785
|
-
url: toPathString(localVarUrlObj),
|
|
43786
|
-
axiosOptions: localVarRequestOptions,
|
|
43787
|
-
};
|
|
43788
|
-
},
|
|
43789
|
-
}
|
|
43790
|
-
};
|
|
43791
|
-
|
|
43792
|
-
/**
|
|
43793
|
-
* DiscoveredApplicationsBetaApi - functional programming interface
|
|
43794
|
-
* @export
|
|
43795
|
-
*/
|
|
43796
|
-
export const DiscoveredApplicationsBetaApiFp = function(configuration?: Configuration) {
|
|
43797
|
-
const localVarAxiosParamCreator = DiscoveredApplicationsBetaApiAxiosParamCreator(configuration)
|
|
43798
|
-
return {
|
|
43799
|
-
/**
|
|
43800
|
-
* Fetches 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.
|
|
43801
|
-
* @summary Retrieve discovered applications for tenant
|
|
43802
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43803
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43804
|
-
* @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*
|
|
43805
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
43806
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
43807
|
-
* @throws {RequiredError}
|
|
43808
|
-
*/
|
|
43809
|
-
async getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>> {
|
|
43810
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, filter, sorters, axiosOptions);
|
|
43811
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
43812
|
-
},
|
|
43813
|
-
}
|
|
43814
|
-
};
|
|
43815
|
-
|
|
43816
|
-
/**
|
|
43817
|
-
* DiscoveredApplicationsBetaApi - factory interface
|
|
43818
|
-
* @export
|
|
43819
|
-
*/
|
|
43820
|
-
export const DiscoveredApplicationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
43821
|
-
const localVarFp = DiscoveredApplicationsBetaApiFp(configuration)
|
|
43822
|
-
return {
|
|
43823
|
-
/**
|
|
43824
|
-
* Fetches 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.
|
|
43825
|
-
* @summary Retrieve discovered applications for tenant
|
|
43826
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43827
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43828
|
-
* @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*
|
|
43829
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
43830
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
43831
|
-
* @throws {RequiredError}
|
|
43832
|
-
*/
|
|
43833
|
-
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>> {
|
|
43834
|
-
return localVarFp.getDiscoveredApplications(limit, offset, filter, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
43835
|
-
},
|
|
43836
|
-
};
|
|
43837
|
-
};
|
|
43838
|
-
|
|
43839
|
-
/**
|
|
43840
|
-
* Request parameters for getDiscoveredApplications operation in DiscoveredApplicationsBetaApi.
|
|
43841
|
-
* @export
|
|
43842
|
-
* @interface DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest
|
|
43843
|
-
*/
|
|
43844
|
-
export interface DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest {
|
|
43845
|
-
/**
|
|
43846
|
-
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43847
|
-
* @type {number}
|
|
43848
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
43849
|
-
*/
|
|
43850
|
-
readonly limit?: number
|
|
43851
|
-
|
|
43852
|
-
/**
|
|
43853
|
-
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43854
|
-
* @type {number}
|
|
43855
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
43856
|
-
*/
|
|
43857
|
-
readonly offset?: number
|
|
43858
|
-
|
|
43859
|
-
/**
|
|
43860
|
-
* Filter results using the standard syntax described in [V3 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*
|
|
43861
|
-
* @type {string}
|
|
43862
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
43863
|
-
*/
|
|
43864
|
-
readonly filter?: string
|
|
43865
|
-
|
|
43866
|
-
/**
|
|
43867
|
-
* Sort results using the standard syntax described in [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**
|
|
43868
|
-
* @type {string}
|
|
43869
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
43870
|
-
*/
|
|
43871
|
-
readonly sorters?: string
|
|
43872
|
-
}
|
|
43873
|
-
|
|
43874
|
-
/**
|
|
43875
|
-
* DiscoveredApplicationsBetaApi - object-oriented interface
|
|
43876
|
-
* @export
|
|
43877
|
-
* @class DiscoveredApplicationsBetaApi
|
|
43878
|
-
* @extends {BaseAPI}
|
|
43879
|
-
*/
|
|
43880
|
-
export class DiscoveredApplicationsBetaApi extends BaseAPI {
|
|
43881
|
-
/**
|
|
43882
|
-
* Fetches 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.
|
|
43883
|
-
* @summary Retrieve discovered applications for tenant
|
|
43884
|
-
* @param {DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters.
|
|
43885
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
43886
|
-
* @throws {RequiredError}
|
|
43887
|
-
* @memberof DiscoveredApplicationsBetaApi
|
|
43888
|
-
*/
|
|
43889
|
-
public getDiscoveredApplications(requestParameters: DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: AxiosRequestConfig) {
|
|
43890
|
-
return DiscoveredApplicationsBetaApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
43891
|
-
}
|
|
43892
|
-
}
|
|
43893
|
-
|
|
43894
|
-
|
|
43895
44281
|
/**
|
|
43896
44282
|
* EntitlementsBetaApi - axios parameter creator
|
|
43897
44283
|
* @export
|
|
@@ -50233,7 +50619,7 @@ export const IAIRoleMiningBetaApiAxiosParamCreator = function (configuration?: C
|
|
|
50233
50619
|
},
|
|
50234
50620
|
/**
|
|
50235
50621
|
* This method returns a specific potential role for a role mining session.
|
|
50236
|
-
* @summary
|
|
50622
|
+
* @summary Retrieve potential role in session
|
|
50237
50623
|
* @param {string} sessionId The role mining session id
|
|
50238
50624
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
50239
50625
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -50406,7 +50792,7 @@ export const IAIRoleMiningBetaApiAxiosParamCreator = function (configuration?: C
|
|
|
50406
50792
|
},
|
|
50407
50793
|
/**
|
|
50408
50794
|
* This method returns the potential role summaries for a role mining session.
|
|
50409
|
-
* @summary
|
|
50795
|
+
* @summary Retrieve session\'s potential role summaries
|
|
50410
50796
|
* @param {string} sessionId The role mining session id
|
|
50411
50797
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
50412
50798
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -50719,8 +51105,8 @@ export const IAIRoleMiningBetaApiAxiosParamCreator = function (configuration?: C
|
|
|
50719
51105
|
};
|
|
50720
51106
|
},
|
|
50721
51107
|
/**
|
|
50722
|
-
*
|
|
50723
|
-
* @summary Update a potential role
|
|
51108
|
+
* 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.**
|
|
51109
|
+
* @summary Update a potential role in session
|
|
50724
51110
|
* @param {string} sessionId The role mining session id
|
|
50725
51111
|
* @param {string} potentialRoleId The potential role summary id
|
|
50726
51112
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -50771,23 +51157,19 @@ export const IAIRoleMiningBetaApiAxiosParamCreator = function (configuration?: C
|
|
|
50771
51157
|
};
|
|
50772
51158
|
},
|
|
50773
51159
|
/**
|
|
50774
|
-
*
|
|
51160
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
50775
51161
|
* @summary Update a potential role
|
|
50776
|
-
* @param {string} sessionId The role mining session id
|
|
50777
51162
|
* @param {string} potentialRoleId The potential role summary id
|
|
50778
51163
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
50779
51164
|
* @param {*} [axiosOptions] Override http request option.
|
|
50780
51165
|
* @throws {RequiredError}
|
|
50781
51166
|
*/
|
|
50782
|
-
|
|
50783
|
-
// verify required parameter 'sessionId' is not null or undefined
|
|
50784
|
-
assertParamExists('patchPotentialRole_1', 'sessionId', sessionId)
|
|
51167
|
+
patchRoleMiningPotentialRole: async (potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50785
51168
|
// verify required parameter 'potentialRoleId' is not null or undefined
|
|
50786
|
-
assertParamExists('
|
|
51169
|
+
assertParamExists('patchRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId)
|
|
50787
51170
|
// verify required parameter 'patchPotentialRoleRequestInnerBeta' is not null or undefined
|
|
50788
|
-
assertParamExists('
|
|
51171
|
+
assertParamExists('patchRoleMiningPotentialRole', 'patchPotentialRoleRequestInnerBeta', patchPotentialRoleRequestInnerBeta)
|
|
50789
51172
|
const localVarPath = `/role-mining-potential-roles/{potentialRoleId}`
|
|
50790
|
-
.replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId)))
|
|
50791
51173
|
.replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId)));
|
|
50792
51174
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50793
51175
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -51091,7 +51473,7 @@ export const IAIRoleMiningBetaApiFp = function(configuration?: Configuration) {
|
|
|
51091
51473
|
},
|
|
51092
51474
|
/**
|
|
51093
51475
|
* This method returns a specific potential role for a role mining session.
|
|
51094
|
-
* @summary
|
|
51476
|
+
* @summary Retrieve potential role in session
|
|
51095
51477
|
* @param {string} sessionId The role mining session id
|
|
51096
51478
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
51097
51479
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -51134,7 +51516,7 @@ export const IAIRoleMiningBetaApiFp = function(configuration?: Configuration) {
|
|
|
51134
51516
|
},
|
|
51135
51517
|
/**
|
|
51136
51518
|
* This method returns the potential role summaries for a role mining session.
|
|
51137
|
-
* @summary
|
|
51519
|
+
* @summary Retrieve session\'s potential role summaries
|
|
51138
51520
|
* @param {string} sessionId The role mining session id
|
|
51139
51521
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
51140
51522
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -51211,8 +51593,8 @@ export const IAIRoleMiningBetaApiFp = function(configuration?: Configuration) {
|
|
|
51211
51593
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51212
51594
|
},
|
|
51213
51595
|
/**
|
|
51214
|
-
*
|
|
51215
|
-
* @summary Update a potential role
|
|
51596
|
+
* 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.**
|
|
51597
|
+
* @summary Update a potential role in session
|
|
51216
51598
|
* @param {string} sessionId The role mining session id
|
|
51217
51599
|
* @param {string} potentialRoleId The potential role summary id
|
|
51218
51600
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -51224,16 +51606,15 @@ export const IAIRoleMiningBetaApiFp = function(configuration?: Configuration) {
|
|
|
51224
51606
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51225
51607
|
},
|
|
51226
51608
|
/**
|
|
51227
|
-
*
|
|
51609
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
51228
51610
|
* @summary Update a potential role
|
|
51229
|
-
* @param {string} sessionId The role mining session id
|
|
51230
51611
|
* @param {string} potentialRoleId The potential role summary id
|
|
51231
51612
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
51232
51613
|
* @param {*} [axiosOptions] Override http request option.
|
|
51233
51614
|
* @throws {RequiredError}
|
|
51234
51615
|
*/
|
|
51235
|
-
async
|
|
51236
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
51616
|
+
async patchRoleMiningPotentialRole(potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
51617
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningPotentialRole(potentialRoleId, patchPotentialRoleRequestInnerBeta, axiosOptions);
|
|
51237
51618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51238
51619
|
},
|
|
51239
51620
|
/**
|
|
@@ -51419,7 +51800,7 @@ export const IAIRoleMiningBetaApiFactory = function (configuration?: Configurati
|
|
|
51419
51800
|
},
|
|
51420
51801
|
/**
|
|
51421
51802
|
* This method returns a specific potential role for a role mining session.
|
|
51422
|
-
* @summary
|
|
51803
|
+
* @summary Retrieve potential role in session
|
|
51423
51804
|
* @param {string} sessionId The role mining session id
|
|
51424
51805
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
51425
51806
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -51459,7 +51840,7 @@ export const IAIRoleMiningBetaApiFactory = function (configuration?: Configurati
|
|
|
51459
51840
|
},
|
|
51460
51841
|
/**
|
|
51461
51842
|
* This method returns the potential role summaries for a role mining session.
|
|
51462
|
-
* @summary
|
|
51843
|
+
* @summary Retrieve session\'s potential role summaries
|
|
51463
51844
|
* @param {string} sessionId The role mining session id
|
|
51464
51845
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
51465
51846
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -51530,8 +51911,8 @@ export const IAIRoleMiningBetaApiFactory = function (configuration?: Configurati
|
|
|
51530
51911
|
return localVarFp.getSavedPotentialRoles(sorters, offset, limit, count, axiosOptions).then((request) => request(axios, basePath));
|
|
51531
51912
|
},
|
|
51532
51913
|
/**
|
|
51533
|
-
*
|
|
51534
|
-
* @summary Update a potential role
|
|
51914
|
+
* 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.**
|
|
51915
|
+
* @summary Update a potential role in session
|
|
51535
51916
|
* @param {string} sessionId The role mining session id
|
|
51536
51917
|
* @param {string} potentialRoleId The potential role summary id
|
|
51537
51918
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -51542,16 +51923,15 @@ export const IAIRoleMiningBetaApiFactory = function (configuration?: Configurati
|
|
|
51542
51923
|
return localVarFp.patchPotentialRole(sessionId, potentialRoleId, patchPotentialRoleRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
51543
51924
|
},
|
|
51544
51925
|
/**
|
|
51545
|
-
*
|
|
51926
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
51546
51927
|
* @summary Update a potential role
|
|
51547
|
-
* @param {string} sessionId The role mining session id
|
|
51548
51928
|
* @param {string} potentialRoleId The potential role summary id
|
|
51549
51929
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
51550
51930
|
* @param {*} [axiosOptions] Override http request option.
|
|
51551
51931
|
* @throws {RequiredError}
|
|
51552
51932
|
*/
|
|
51553
|
-
|
|
51554
|
-
return localVarFp.
|
|
51933
|
+
patchRoleMiningPotentialRole(potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: any): AxiosPromise<object> {
|
|
51934
|
+
return localVarFp.patchRoleMiningPotentialRole(potentialRoleId, patchPotentialRoleRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
51555
51935
|
},
|
|
51556
51936
|
/**
|
|
51557
51937
|
* 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.
|
|
@@ -52294,29 +52674,22 @@ export interface IAIRoleMiningBetaApiPatchPotentialRoleRequest {
|
|
|
52294
52674
|
}
|
|
52295
52675
|
|
|
52296
52676
|
/**
|
|
52297
|
-
* Request parameters for
|
|
52677
|
+
* Request parameters for patchRoleMiningPotentialRole operation in IAIRoleMiningBetaApi.
|
|
52298
52678
|
* @export
|
|
52299
|
-
* @interface
|
|
52679
|
+
* @interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest
|
|
52300
52680
|
*/
|
|
52301
|
-
export interface
|
|
52302
|
-
/**
|
|
52303
|
-
* The role mining session id
|
|
52304
|
-
* @type {string}
|
|
52305
|
-
* @memberof IAIRoleMiningBetaApiPatchPotentialRole0
|
|
52306
|
-
*/
|
|
52307
|
-
readonly sessionId: string
|
|
52308
|
-
|
|
52681
|
+
export interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest {
|
|
52309
52682
|
/**
|
|
52310
52683
|
* The potential role summary id
|
|
52311
52684
|
* @type {string}
|
|
52312
|
-
* @memberof
|
|
52685
|
+
* @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole
|
|
52313
52686
|
*/
|
|
52314
52687
|
readonly potentialRoleId: string
|
|
52315
52688
|
|
|
52316
52689
|
/**
|
|
52317
52690
|
*
|
|
52318
52691
|
* @type {Array<PatchPotentialRoleRequestInnerBeta>}
|
|
52319
|
-
* @memberof
|
|
52692
|
+
* @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole
|
|
52320
52693
|
*/
|
|
52321
52694
|
readonly patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>
|
|
52322
52695
|
}
|
|
@@ -52511,7 +52884,7 @@ export class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
52511
52884
|
|
|
52512
52885
|
/**
|
|
52513
52886
|
* This method returns a specific potential role for a role mining session.
|
|
52514
|
-
* @summary
|
|
52887
|
+
* @summary Retrieve potential role in session
|
|
52515
52888
|
* @param {IAIRoleMiningBetaApiGetPotentialRoleRequest} requestParameters Request parameters.
|
|
52516
52889
|
* @param {*} [axiosOptions] Override http request option.
|
|
52517
52890
|
* @throws {RequiredError}
|
|
@@ -52547,7 +52920,7 @@ export class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
52547
52920
|
|
|
52548
52921
|
/**
|
|
52549
52922
|
* This method returns the potential role summaries for a role mining session.
|
|
52550
|
-
* @summary
|
|
52923
|
+
* @summary Retrieve session\'s potential role summaries
|
|
52551
52924
|
* @param {IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest} requestParameters Request parameters.
|
|
52552
52925
|
* @param {*} [axiosOptions] Override http request option.
|
|
52553
52926
|
* @throws {RequiredError}
|
|
@@ -52618,8 +52991,8 @@ export class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
52618
52991
|
}
|
|
52619
52992
|
|
|
52620
52993
|
/**
|
|
52621
|
-
*
|
|
52622
|
-
* @summary Update a potential role
|
|
52994
|
+
* 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.**
|
|
52995
|
+
* @summary Update a potential role in session
|
|
52623
52996
|
* @param {IAIRoleMiningBetaApiPatchPotentialRoleRequest} requestParameters Request parameters.
|
|
52624
52997
|
* @param {*} [axiosOptions] Override http request option.
|
|
52625
52998
|
* @throws {RequiredError}
|
|
@@ -52630,15 +53003,15 @@ export class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
52630
53003
|
}
|
|
52631
53004
|
|
|
52632
53005
|
/**
|
|
52633
|
-
*
|
|
53006
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
52634
53007
|
* @summary Update a potential role
|
|
52635
|
-
* @param {
|
|
53008
|
+
* @param {IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest} requestParameters Request parameters.
|
|
52636
53009
|
* @param {*} [axiosOptions] Override http request option.
|
|
52637
53010
|
* @throws {RequiredError}
|
|
52638
53011
|
* @memberof IAIRoleMiningBetaApi
|
|
52639
53012
|
*/
|
|
52640
|
-
public
|
|
52641
|
-
return IAIRoleMiningBetaApiFp(this.configuration).
|
|
53013
|
+
public patchRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest, axiosOptions?: AxiosRequestConfig) {
|
|
53014
|
+
return IAIRoleMiningBetaApiFp(this.configuration).patchRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.patchPotentialRoleRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
52642
53015
|
}
|
|
52643
53016
|
|
|
52644
53017
|
/**
|
|
@@ -55193,11 +55566,14 @@ export const IdentityHistoryBetaApiAxiosParamCreator = function (configuration?:
|
|
|
55193
55566
|
* This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of \'idn:identity-history:read\'
|
|
55194
55567
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
55195
55568
|
* @param {string} id The identity id
|
|
55196
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
55569
|
+
* @param {string} [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**
|
|
55570
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
55571
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
55572
|
+
* @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**
|
|
55197
55573
|
* @param {*} [axiosOptions] Override http request option.
|
|
55198
55574
|
* @throws {RequiredError}
|
|
55199
55575
|
*/
|
|
55200
|
-
listIdentityAccessItems: async (id: string, type?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55576
|
+
listIdentityAccessItems: async (id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55201
55577
|
// verify required parameter 'id' is not null or undefined
|
|
55202
55578
|
assertParamExists('listIdentityAccessItems', 'id', id)
|
|
55203
55579
|
const localVarPath = `/historical-identities/{id}/access-items`
|
|
@@ -55225,6 +55601,18 @@ export const IdentityHistoryBetaApiAxiosParamCreator = function (configuration?:
|
|
|
55225
55601
|
localVarQueryParameter['type'] = type;
|
|
55226
55602
|
}
|
|
55227
55603
|
|
|
55604
|
+
if (filters !== undefined) {
|
|
55605
|
+
localVarQueryParameter['filters'] = filters;
|
|
55606
|
+
}
|
|
55607
|
+
|
|
55608
|
+
if (sorters !== undefined) {
|
|
55609
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
55610
|
+
}
|
|
55611
|
+
|
|
55612
|
+
if (query !== undefined) {
|
|
55613
|
+
localVarQueryParameter['query'] = query;
|
|
55614
|
+
}
|
|
55615
|
+
|
|
55228
55616
|
|
|
55229
55617
|
|
|
55230
55618
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -55486,12 +55874,15 @@ export const IdentityHistoryBetaApiFp = function(configuration?: Configuration)
|
|
|
55486
55874
|
* This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of \'idn:identity-history:read\'
|
|
55487
55875
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
55488
55876
|
* @param {string} id The identity id
|
|
55489
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
55877
|
+
* @param {string} [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**
|
|
55878
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
55879
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
55880
|
+
* @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**
|
|
55490
55881
|
* @param {*} [axiosOptions] Override http request option.
|
|
55491
55882
|
* @throws {RequiredError}
|
|
55492
55883
|
*/
|
|
55493
|
-
async listIdentityAccessItems(id: string, type?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>> {
|
|
55494
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, axiosOptions);
|
|
55884
|
+
async listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>> {
|
|
55885
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, filters, sorters, query, axiosOptions);
|
|
55495
55886
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55496
55887
|
},
|
|
55497
55888
|
/**
|
|
@@ -55647,12 +56038,15 @@ export const IdentityHistoryBetaApiFactory = function (configuration?: Configura
|
|
|
55647
56038
|
* This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of \'idn:identity-history:read\'
|
|
55648
56039
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
55649
56040
|
* @param {string} id The identity id
|
|
55650
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
56041
|
+
* @param {string} [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**
|
|
56042
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
56043
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
56044
|
+
* @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**
|
|
55651
56045
|
* @param {*} [axiosOptions] Override http request option.
|
|
55652
56046
|
* @throws {RequiredError}
|
|
55653
56047
|
*/
|
|
55654
|
-
listIdentityAccessItems(id: string, type?: string, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>> {
|
|
55655
|
-
return localVarFp.listIdentityAccessItems(id, type, axiosOptions).then((request) => request(axios, basePath));
|
|
56048
|
+
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>> {
|
|
56049
|
+
return localVarFp.listIdentityAccessItems(id, type, filters, sorters, query, axiosOptions).then((request) => request(axios, basePath));
|
|
55656
56050
|
},
|
|
55657
56051
|
/**
|
|
55658
56052
|
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
@@ -56020,11 +56414,32 @@ export interface IdentityHistoryBetaApiListIdentityAccessItemsRequest {
|
|
|
56020
56414
|
readonly id: string
|
|
56021
56415
|
|
|
56022
56416
|
/**
|
|
56023
|
-
* The type of access item for the identity. If not provided, it defaults to account
|
|
56417
|
+
* The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role**
|
|
56024
56418
|
* @type {string}
|
|
56025
56419
|
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
56026
56420
|
*/
|
|
56027
56421
|
readonly type?: string
|
|
56422
|
+
|
|
56423
|
+
/**
|
|
56424
|
+
* Filter results using the standard syntax described in [V3 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*
|
|
56425
|
+
* @type {string}
|
|
56426
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
56427
|
+
*/
|
|
56428
|
+
readonly filters?: string
|
|
56429
|
+
|
|
56430
|
+
/**
|
|
56431
|
+
* Sort results using the standard syntax described in [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**
|
|
56432
|
+
* @type {string}
|
|
56433
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
56434
|
+
*/
|
|
56435
|
+
readonly sorters?: string
|
|
56436
|
+
|
|
56437
|
+
/**
|
|
56438
|
+
* 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**
|
|
56439
|
+
* @type {string}
|
|
56440
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
56441
|
+
*/
|
|
56442
|
+
readonly query?: string
|
|
56028
56443
|
}
|
|
56029
56444
|
|
|
56030
56445
|
/**
|
|
@@ -56216,7 +56631,7 @@ export class IdentityHistoryBetaApi extends BaseAPI {
|
|
|
56216
56631
|
* @memberof IdentityHistoryBetaApi
|
|
56217
56632
|
*/
|
|
56218
56633
|
public listIdentityAccessItems(requestParameters: IdentityHistoryBetaApiListIdentityAccessItemsRequest, axiosOptions?: AxiosRequestConfig) {
|
|
56219
|
-
return IdentityHistoryBetaApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
56634
|
+
return IdentityHistoryBetaApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
56220
56635
|
}
|
|
56221
56636
|
|
|
56222
56637
|
/**
|
|
@@ -56252,7 +56667,7 @@ export class IdentityHistoryBetaApi extends BaseAPI {
|
|
|
56252
56667
|
export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
56253
56668
|
return {
|
|
56254
56669
|
/**
|
|
56255
|
-
* This creates an Identity Profile
|
|
56670
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
56256
56671
|
* @summary Create an Identity Profile
|
|
56257
56672
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
56258
56673
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56374,7 +56789,198 @@ export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?
|
|
|
56374
56789
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56375
56790
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56376
56791
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56377
|
-
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
|
|
56792
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
|
|
56793
|
+
|
|
56794
|
+
return {
|
|
56795
|
+
url: toPathString(localVarUrlObj),
|
|
56796
|
+
axiosOptions: localVarRequestOptions,
|
|
56797
|
+
};
|
|
56798
|
+
},
|
|
56799
|
+
/**
|
|
56800
|
+
* This exports existing identity profiles in the format specified by the sp-config service.
|
|
56801
|
+
* @summary Export Identity Profiles
|
|
56802
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56803
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56804
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56805
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard 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*
|
|
56806
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
56807
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
56808
|
+
* @throws {RequiredError}
|
|
56809
|
+
*/
|
|
56810
|
+
exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56811
|
+
const localVarPath = `/identity-profiles/export`;
|
|
56812
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56813
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56814
|
+
let baseOptions;
|
|
56815
|
+
if (configuration) {
|
|
56816
|
+
baseOptions = configuration.baseOptions;
|
|
56817
|
+
}
|
|
56818
|
+
|
|
56819
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56820
|
+
const localVarHeaderParameter = {} as any;
|
|
56821
|
+
const localVarQueryParameter = {} as any;
|
|
56822
|
+
|
|
56823
|
+
// authentication UserContextAuth required
|
|
56824
|
+
// oauth required
|
|
56825
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56826
|
+
|
|
56827
|
+
// authentication UserContextAuth required
|
|
56828
|
+
// oauth required
|
|
56829
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56830
|
+
|
|
56831
|
+
if (limit !== undefined) {
|
|
56832
|
+
localVarQueryParameter['limit'] = limit;
|
|
56833
|
+
}
|
|
56834
|
+
|
|
56835
|
+
if (offset !== undefined) {
|
|
56836
|
+
localVarQueryParameter['offset'] = offset;
|
|
56837
|
+
}
|
|
56838
|
+
|
|
56839
|
+
if (count !== undefined) {
|
|
56840
|
+
localVarQueryParameter['count'] = count;
|
|
56841
|
+
}
|
|
56842
|
+
|
|
56843
|
+
if (filters !== undefined) {
|
|
56844
|
+
localVarQueryParameter['filters'] = filters;
|
|
56845
|
+
}
|
|
56846
|
+
|
|
56847
|
+
if (sorters !== undefined) {
|
|
56848
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
56849
|
+
}
|
|
56850
|
+
|
|
56851
|
+
|
|
56852
|
+
|
|
56853
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56854
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56855
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56856
|
+
|
|
56857
|
+
return {
|
|
56858
|
+
url: toPathString(localVarUrlObj),
|
|
56859
|
+
axiosOptions: localVarRequestOptions,
|
|
56860
|
+
};
|
|
56861
|
+
},
|
|
56862
|
+
/**
|
|
56863
|
+
* 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.
|
|
56864
|
+
* @summary Default identity attribute config
|
|
56865
|
+
* @param {string} identityProfileId The Identity Profile ID
|
|
56866
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
56867
|
+
* @throws {RequiredError}
|
|
56868
|
+
*/
|
|
56869
|
+
getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56870
|
+
// verify required parameter 'identityProfileId' is not null or undefined
|
|
56871
|
+
assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId)
|
|
56872
|
+
const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config`
|
|
56873
|
+
.replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId)));
|
|
56874
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56875
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56876
|
+
let baseOptions;
|
|
56877
|
+
if (configuration) {
|
|
56878
|
+
baseOptions = configuration.baseOptions;
|
|
56879
|
+
}
|
|
56880
|
+
|
|
56881
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56882
|
+
const localVarHeaderParameter = {} as any;
|
|
56883
|
+
const localVarQueryParameter = {} as any;
|
|
56884
|
+
|
|
56885
|
+
// authentication UserContextAuth required
|
|
56886
|
+
// oauth required
|
|
56887
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56888
|
+
|
|
56889
|
+
// authentication UserContextAuth required
|
|
56890
|
+
// oauth required
|
|
56891
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56892
|
+
|
|
56893
|
+
|
|
56894
|
+
|
|
56895
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56896
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56897
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56898
|
+
|
|
56899
|
+
return {
|
|
56900
|
+
url: toPathString(localVarUrlObj),
|
|
56901
|
+
axiosOptions: localVarRequestOptions,
|
|
56902
|
+
};
|
|
56903
|
+
},
|
|
56904
|
+
/**
|
|
56905
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
56906
|
+
* @summary Gets a single Identity Profile
|
|
56907
|
+
* @param {string} identityProfileId The Identity Profile ID
|
|
56908
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
56909
|
+
* @throws {RequiredError}
|
|
56910
|
+
*/
|
|
56911
|
+
getIdentityProfile: async (identityProfileId: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56912
|
+
// verify required parameter 'identityProfileId' is not null or undefined
|
|
56913
|
+
assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId)
|
|
56914
|
+
const localVarPath = `/identity-profiles/{identity-profile-id}`
|
|
56915
|
+
.replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId)));
|
|
56916
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56917
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56918
|
+
let baseOptions;
|
|
56919
|
+
if (configuration) {
|
|
56920
|
+
baseOptions = configuration.baseOptions;
|
|
56921
|
+
}
|
|
56922
|
+
|
|
56923
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56924
|
+
const localVarHeaderParameter = {} as any;
|
|
56925
|
+
const localVarQueryParameter = {} as any;
|
|
56926
|
+
|
|
56927
|
+
// authentication UserContextAuth required
|
|
56928
|
+
// oauth required
|
|
56929
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56930
|
+
|
|
56931
|
+
// authentication UserContextAuth required
|
|
56932
|
+
// oauth required
|
|
56933
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56934
|
+
|
|
56935
|
+
|
|
56936
|
+
|
|
56937
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56938
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56939
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56940
|
+
|
|
56941
|
+
return {
|
|
56942
|
+
url: toPathString(localVarUrlObj),
|
|
56943
|
+
axiosOptions: localVarRequestOptions,
|
|
56944
|
+
};
|
|
56945
|
+
},
|
|
56946
|
+
/**
|
|
56947
|
+
* This imports previously exported identity profiles.
|
|
56948
|
+
* @summary Import Identity Profiles
|
|
56949
|
+
* @param {Array<IdentityProfileExportedObjectBeta>} identityProfileExportedObjectBeta Previously exported Identity Profiles.
|
|
56950
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
56951
|
+
* @throws {RequiredError}
|
|
56952
|
+
*/
|
|
56953
|
+
importIdentityProfiles: async (identityProfileExportedObjectBeta: Array<IdentityProfileExportedObjectBeta>, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56954
|
+
// verify required parameter 'identityProfileExportedObjectBeta' is not null or undefined
|
|
56955
|
+
assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectBeta', identityProfileExportedObjectBeta)
|
|
56956
|
+
const localVarPath = `/identity-profiles/import`;
|
|
56957
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56958
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56959
|
+
let baseOptions;
|
|
56960
|
+
if (configuration) {
|
|
56961
|
+
baseOptions = configuration.baseOptions;
|
|
56962
|
+
}
|
|
56963
|
+
|
|
56964
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
56965
|
+
const localVarHeaderParameter = {} as any;
|
|
56966
|
+
const localVarQueryParameter = {} as any;
|
|
56967
|
+
|
|
56968
|
+
// authentication UserContextAuth required
|
|
56969
|
+
// oauth required
|
|
56970
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56971
|
+
|
|
56972
|
+
// authentication UserContextAuth required
|
|
56973
|
+
// oauth required
|
|
56974
|
+
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56975
|
+
|
|
56976
|
+
|
|
56977
|
+
|
|
56978
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
56979
|
+
|
|
56980
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56981
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56982
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56983
|
+
localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectBeta, localVarRequestOptions, configuration)
|
|
56378
56984
|
|
|
56379
56985
|
return {
|
|
56380
56986
|
url: toPathString(localVarUrlObj),
|
|
@@ -56382,18 +56988,18 @@ export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?
|
|
|
56382
56988
|
};
|
|
56383
56989
|
},
|
|
56384
56990
|
/**
|
|
56385
|
-
* This
|
|
56386
|
-
* @summary
|
|
56991
|
+
* This returns 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.
|
|
56992
|
+
* @summary Identity Profiles List
|
|
56387
56993
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56388
56994
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56389
56995
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56390
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard 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*
|
|
56391
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
56996
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard 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, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne*
|
|
56997
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
56392
56998
|
* @param {*} [axiosOptions] Override http request option.
|
|
56393
56999
|
* @throws {RequiredError}
|
|
56394
57000
|
*/
|
|
56395
|
-
|
|
56396
|
-
const localVarPath = `/identity-profiles
|
|
57001
|
+
listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57002
|
+
const localVarPath = `/identity-profiles`;
|
|
56397
57003
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56398
57004
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56399
57005
|
let baseOptions;
|
|
@@ -56445,15 +57051,15 @@ export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?
|
|
|
56445
57051
|
};
|
|
56446
57052
|
},
|
|
56447
57053
|
/**
|
|
56448
|
-
*
|
|
57054
|
+
* 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.
|
|
56449
57055
|
* @summary Generate Identity Profile Preview
|
|
56450
57056
|
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
56451
57057
|
* @param {*} [axiosOptions] Override http request option.
|
|
56452
57058
|
* @throws {RequiredError}
|
|
56453
57059
|
*/
|
|
56454
|
-
|
|
57060
|
+
showGenerateIdentityPreview: async (identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56455
57061
|
// verify required parameter 'identityPreviewRequestBeta' is not null or undefined
|
|
56456
|
-
assertParamExists('
|
|
57062
|
+
assertParamExists('showGenerateIdentityPreview', 'identityPreviewRequestBeta', identityPreviewRequestBeta)
|
|
56457
57063
|
const localVarPath = `/identity-profiles/identity-preview`;
|
|
56458
57064
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56459
57065
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -56488,197 +57094,6 @@ export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?
|
|
|
56488
57094
|
axiosOptions: localVarRequestOptions,
|
|
56489
57095
|
};
|
|
56490
57096
|
},
|
|
56491
|
-
/**
|
|
56492
|
-
* 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.
|
|
56493
|
-
* @summary Default identity attribute config
|
|
56494
|
-
* @param {string} identityProfileId The Identity Profile ID
|
|
56495
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56496
|
-
* @throws {RequiredError}
|
|
56497
|
-
*/
|
|
56498
|
-
getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56499
|
-
// verify required parameter 'identityProfileId' is not null or undefined
|
|
56500
|
-
assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId)
|
|
56501
|
-
const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config`
|
|
56502
|
-
.replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId)));
|
|
56503
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56504
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56505
|
-
let baseOptions;
|
|
56506
|
-
if (configuration) {
|
|
56507
|
-
baseOptions = configuration.baseOptions;
|
|
56508
|
-
}
|
|
56509
|
-
|
|
56510
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56511
|
-
const localVarHeaderParameter = {} as any;
|
|
56512
|
-
const localVarQueryParameter = {} as any;
|
|
56513
|
-
|
|
56514
|
-
// authentication UserContextAuth required
|
|
56515
|
-
// oauth required
|
|
56516
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56517
|
-
|
|
56518
|
-
// authentication UserContextAuth required
|
|
56519
|
-
// oauth required
|
|
56520
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56521
|
-
|
|
56522
|
-
|
|
56523
|
-
|
|
56524
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56525
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56526
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56527
|
-
|
|
56528
|
-
return {
|
|
56529
|
-
url: toPathString(localVarUrlObj),
|
|
56530
|
-
axiosOptions: localVarRequestOptions,
|
|
56531
|
-
};
|
|
56532
|
-
},
|
|
56533
|
-
/**
|
|
56534
|
-
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
56535
|
-
* @summary Gets a single Identity Profile
|
|
56536
|
-
* @param {string} identityProfileId The Identity Profile ID
|
|
56537
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56538
|
-
* @throws {RequiredError}
|
|
56539
|
-
*/
|
|
56540
|
-
getIdentityProfile: async (identityProfileId: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56541
|
-
// verify required parameter 'identityProfileId' is not null or undefined
|
|
56542
|
-
assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId)
|
|
56543
|
-
const localVarPath = `/identity-profiles/{identity-profile-id}`
|
|
56544
|
-
.replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId)));
|
|
56545
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56546
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56547
|
-
let baseOptions;
|
|
56548
|
-
if (configuration) {
|
|
56549
|
-
baseOptions = configuration.baseOptions;
|
|
56550
|
-
}
|
|
56551
|
-
|
|
56552
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56553
|
-
const localVarHeaderParameter = {} as any;
|
|
56554
|
-
const localVarQueryParameter = {} as any;
|
|
56555
|
-
|
|
56556
|
-
// authentication UserContextAuth required
|
|
56557
|
-
// oauth required
|
|
56558
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56559
|
-
|
|
56560
|
-
// authentication UserContextAuth required
|
|
56561
|
-
// oauth required
|
|
56562
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56563
|
-
|
|
56564
|
-
|
|
56565
|
-
|
|
56566
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56567
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56568
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56569
|
-
|
|
56570
|
-
return {
|
|
56571
|
-
url: toPathString(localVarUrlObj),
|
|
56572
|
-
axiosOptions: localVarRequestOptions,
|
|
56573
|
-
};
|
|
56574
|
-
},
|
|
56575
|
-
/**
|
|
56576
|
-
* This imports previously exported identity profiles.
|
|
56577
|
-
* @summary Import Identity Profiles
|
|
56578
|
-
* @param {Array<IdentityProfileExportedObjectBeta>} identityProfileExportedObjectBeta Previously exported Identity Profiles.
|
|
56579
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56580
|
-
* @throws {RequiredError}
|
|
56581
|
-
*/
|
|
56582
|
-
importIdentityProfiles: async (identityProfileExportedObjectBeta: Array<IdentityProfileExportedObjectBeta>, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56583
|
-
// verify required parameter 'identityProfileExportedObjectBeta' is not null or undefined
|
|
56584
|
-
assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectBeta', identityProfileExportedObjectBeta)
|
|
56585
|
-
const localVarPath = `/identity-profiles/import`;
|
|
56586
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56587
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56588
|
-
let baseOptions;
|
|
56589
|
-
if (configuration) {
|
|
56590
|
-
baseOptions = configuration.baseOptions;
|
|
56591
|
-
}
|
|
56592
|
-
|
|
56593
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
56594
|
-
const localVarHeaderParameter = {} as any;
|
|
56595
|
-
const localVarQueryParameter = {} as any;
|
|
56596
|
-
|
|
56597
|
-
// authentication UserContextAuth required
|
|
56598
|
-
// oauth required
|
|
56599
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56600
|
-
|
|
56601
|
-
// authentication UserContextAuth required
|
|
56602
|
-
// oauth required
|
|
56603
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56604
|
-
|
|
56605
|
-
|
|
56606
|
-
|
|
56607
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
56608
|
-
|
|
56609
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56610
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56611
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56612
|
-
localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectBeta, localVarRequestOptions, configuration)
|
|
56613
|
-
|
|
56614
|
-
return {
|
|
56615
|
-
url: toPathString(localVarUrlObj),
|
|
56616
|
-
axiosOptions: localVarRequestOptions,
|
|
56617
|
-
};
|
|
56618
|
-
},
|
|
56619
|
-
/**
|
|
56620
|
-
* This returns 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.
|
|
56621
|
-
* @summary Identity Profiles list
|
|
56622
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56623
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56624
|
-
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56625
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard 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, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne*
|
|
56626
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
56627
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56628
|
-
* @throws {RequiredError}
|
|
56629
|
-
*/
|
|
56630
|
-
listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56631
|
-
const localVarPath = `/identity-profiles`;
|
|
56632
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56633
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56634
|
-
let baseOptions;
|
|
56635
|
-
if (configuration) {
|
|
56636
|
-
baseOptions = configuration.baseOptions;
|
|
56637
|
-
}
|
|
56638
|
-
|
|
56639
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
56640
|
-
const localVarHeaderParameter = {} as any;
|
|
56641
|
-
const localVarQueryParameter = {} as any;
|
|
56642
|
-
|
|
56643
|
-
// authentication UserContextAuth required
|
|
56644
|
-
// oauth required
|
|
56645
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56646
|
-
|
|
56647
|
-
// authentication UserContextAuth required
|
|
56648
|
-
// oauth required
|
|
56649
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
56650
|
-
|
|
56651
|
-
if (limit !== undefined) {
|
|
56652
|
-
localVarQueryParameter['limit'] = limit;
|
|
56653
|
-
}
|
|
56654
|
-
|
|
56655
|
-
if (offset !== undefined) {
|
|
56656
|
-
localVarQueryParameter['offset'] = offset;
|
|
56657
|
-
}
|
|
56658
|
-
|
|
56659
|
-
if (count !== undefined) {
|
|
56660
|
-
localVarQueryParameter['count'] = count;
|
|
56661
|
-
}
|
|
56662
|
-
|
|
56663
|
-
if (filters !== undefined) {
|
|
56664
|
-
localVarQueryParameter['filters'] = filters;
|
|
56665
|
-
}
|
|
56666
|
-
|
|
56667
|
-
if (sorters !== undefined) {
|
|
56668
|
-
localVarQueryParameter['sorters'] = sorters;
|
|
56669
|
-
}
|
|
56670
|
-
|
|
56671
|
-
|
|
56672
|
-
|
|
56673
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56674
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56675
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56676
|
-
|
|
56677
|
-
return {
|
|
56678
|
-
url: toPathString(localVarUrlObj),
|
|
56679
|
-
axiosOptions: localVarRequestOptions,
|
|
56680
|
-
};
|
|
56681
|
-
},
|
|
56682
57097
|
/**
|
|
56683
57098
|
* 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.
|
|
56684
57099
|
* @summary Process identities under profile
|
|
@@ -56722,7 +57137,7 @@ export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?
|
|
|
56722
57137
|
};
|
|
56723
57138
|
},
|
|
56724
57139
|
/**
|
|
56725
|
-
* This updates the specified Identity Profile.
|
|
57140
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
56726
57141
|
* @summary Update the Identity Profile
|
|
56727
57142
|
* @param {string} identityProfileId The Identity Profile ID
|
|
56728
57143
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -56780,7 +57195,7 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56780
57195
|
const localVarAxiosParamCreator = IdentityProfilesBetaApiAxiosParamCreator(configuration)
|
|
56781
57196
|
return {
|
|
56782
57197
|
/**
|
|
56783
|
-
* This creates an Identity Profile
|
|
57198
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
56784
57199
|
* @summary Create an Identity Profile
|
|
56785
57200
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
56786
57201
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56827,17 +57242,6 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56827
57242
|
const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions);
|
|
56828
57243
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56829
57244
|
},
|
|
56830
|
-
/**
|
|
56831
|
-
* 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. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
56832
|
-
* @summary Generate Identity Profile Preview
|
|
56833
|
-
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
56834
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56835
|
-
* @throws {RequiredError}
|
|
56836
|
-
*/
|
|
56837
|
-
async generateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityPreviewResponseBeta>> {
|
|
56838
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreview(identityPreviewRequestBeta, axiosOptions);
|
|
56839
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56840
|
-
},
|
|
56841
57245
|
/**
|
|
56842
57246
|
* 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.
|
|
56843
57247
|
* @summary Default identity attribute config
|
|
@@ -56850,7 +57254,7 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56850
57254
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56851
57255
|
},
|
|
56852
57256
|
/**
|
|
56853
|
-
* This returns a single Identity Profile based on ID.
|
|
57257
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
56854
57258
|
* @summary Gets a single Identity Profile
|
|
56855
57259
|
* @param {string} identityProfileId The Identity Profile ID
|
|
56856
57260
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56873,7 +57277,7 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56873
57277
|
},
|
|
56874
57278
|
/**
|
|
56875
57279
|
* This returns 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.
|
|
56876
|
-
* @summary Identity Profiles
|
|
57280
|
+
* @summary Identity Profiles List
|
|
56877
57281
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56878
57282
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56879
57283
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -56886,6 +57290,17 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56886
57290
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions);
|
|
56887
57291
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56888
57292
|
},
|
|
57293
|
+
/**
|
|
57294
|
+
* 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.
|
|
57295
|
+
* @summary Generate Identity Profile Preview
|
|
57296
|
+
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
57297
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57298
|
+
* @throws {RequiredError}
|
|
57299
|
+
*/
|
|
57300
|
+
async showGenerateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityPreviewResponseBeta>> {
|
|
57301
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.showGenerateIdentityPreview(identityPreviewRequestBeta, axiosOptions);
|
|
57302
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57303
|
+
},
|
|
56889
57304
|
/**
|
|
56890
57305
|
* 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.
|
|
56891
57306
|
* @summary Process identities under profile
|
|
@@ -56898,7 +57313,7 @@ export const IdentityProfilesBetaApiFp = function(configuration?: Configuration)
|
|
|
56898
57313
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56899
57314
|
},
|
|
56900
57315
|
/**
|
|
56901
|
-
* This updates the specified Identity Profile.
|
|
57316
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
56902
57317
|
* @summary Update the Identity Profile
|
|
56903
57318
|
* @param {string} identityProfileId The Identity Profile ID
|
|
56904
57319
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -56920,7 +57335,7 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
56920
57335
|
const localVarFp = IdentityProfilesBetaApiFp(configuration)
|
|
56921
57336
|
return {
|
|
56922
57337
|
/**
|
|
56923
|
-
* This creates an Identity Profile
|
|
57338
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
56924
57339
|
* @summary Create an Identity Profile
|
|
56925
57340
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
56926
57341
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56963,16 +57378,6 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
56963
57378
|
exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfileExportedObjectBeta>> {
|
|
56964
57379
|
return localVarFp.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
56965
57380
|
},
|
|
56966
|
-
/**
|
|
56967
|
-
* 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. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
56968
|
-
* @summary Generate Identity Profile Preview
|
|
56969
|
-
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
56970
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
56971
|
-
* @throws {RequiredError}
|
|
56972
|
-
*/
|
|
56973
|
-
generateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: any): AxiosPromise<IdentityPreviewResponseBeta> {
|
|
56974
|
-
return localVarFp.generateIdentityPreview(identityPreviewRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
56975
|
-
},
|
|
56976
57381
|
/**
|
|
56977
57382
|
* 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.
|
|
56978
57383
|
* @summary Default identity attribute config
|
|
@@ -56984,7 +57389,7 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
56984
57389
|
return localVarFp.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions).then((request) => request(axios, basePath));
|
|
56985
57390
|
},
|
|
56986
57391
|
/**
|
|
56987
|
-
* This returns a single Identity Profile based on ID.
|
|
57392
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
56988
57393
|
* @summary Gets a single Identity Profile
|
|
56989
57394
|
* @param {string} identityProfileId The Identity Profile ID
|
|
56990
57395
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57005,7 +57410,7 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
57005
57410
|
},
|
|
57006
57411
|
/**
|
|
57007
57412
|
* This returns 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.
|
|
57008
|
-
* @summary Identity Profiles
|
|
57413
|
+
* @summary Identity Profiles List
|
|
57009
57414
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
57010
57415
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
57011
57416
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -57017,6 +57422,16 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
57017
57422
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfileBeta>> {
|
|
57018
57423
|
return localVarFp.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
57019
57424
|
},
|
|
57425
|
+
/**
|
|
57426
|
+
* 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.
|
|
57427
|
+
* @summary Generate Identity Profile Preview
|
|
57428
|
+
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
57429
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57430
|
+
* @throws {RequiredError}
|
|
57431
|
+
*/
|
|
57432
|
+
showGenerateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: any): AxiosPromise<IdentityPreviewResponseBeta> {
|
|
57433
|
+
return localVarFp.showGenerateIdentityPreview(identityPreviewRequestBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
57434
|
+
},
|
|
57020
57435
|
/**
|
|
57021
57436
|
* 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.
|
|
57022
57437
|
* @summary Process identities under profile
|
|
@@ -57028,7 +57443,7 @@ export const IdentityProfilesBetaApiFactory = function (configuration?: Configur
|
|
|
57028
57443
|
return localVarFp.syncIdentityProfile(identityProfileId, axiosOptions).then((request) => request(axios, basePath));
|
|
57029
57444
|
},
|
|
57030
57445
|
/**
|
|
57031
|
-
* This updates the specified Identity Profile.
|
|
57446
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
57032
57447
|
* @summary Update the Identity Profile
|
|
57033
57448
|
* @param {string} identityProfileId The Identity Profile ID
|
|
57034
57449
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -57125,20 +57540,6 @@ export interface IdentityProfilesBetaApiExportIdentityProfilesRequest {
|
|
|
57125
57540
|
readonly sorters?: string
|
|
57126
57541
|
}
|
|
57127
57542
|
|
|
57128
|
-
/**
|
|
57129
|
-
* Request parameters for generateIdentityPreview operation in IdentityProfilesBetaApi.
|
|
57130
|
-
* @export
|
|
57131
|
-
* @interface IdentityProfilesBetaApiGenerateIdentityPreviewRequest
|
|
57132
|
-
*/
|
|
57133
|
-
export interface IdentityProfilesBetaApiGenerateIdentityPreviewRequest {
|
|
57134
|
-
/**
|
|
57135
|
-
* Identity Preview request body.
|
|
57136
|
-
* @type {IdentityPreviewRequestBeta}
|
|
57137
|
-
* @memberof IdentityProfilesBetaApiGenerateIdentityPreview
|
|
57138
|
-
*/
|
|
57139
|
-
readonly identityPreviewRequestBeta: IdentityPreviewRequestBeta
|
|
57140
|
-
}
|
|
57141
|
-
|
|
57142
57543
|
/**
|
|
57143
57544
|
* Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesBetaApi.
|
|
57144
57545
|
* @export
|
|
@@ -57223,6 +57624,20 @@ export interface IdentityProfilesBetaApiListIdentityProfilesRequest {
|
|
|
57223
57624
|
readonly sorters?: string
|
|
57224
57625
|
}
|
|
57225
57626
|
|
|
57627
|
+
/**
|
|
57628
|
+
* Request parameters for showGenerateIdentityPreview operation in IdentityProfilesBetaApi.
|
|
57629
|
+
* @export
|
|
57630
|
+
* @interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest
|
|
57631
|
+
*/
|
|
57632
|
+
export interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest {
|
|
57633
|
+
/**
|
|
57634
|
+
* Identity Preview request body.
|
|
57635
|
+
* @type {IdentityPreviewRequestBeta}
|
|
57636
|
+
* @memberof IdentityProfilesBetaApiShowGenerateIdentityPreview
|
|
57637
|
+
*/
|
|
57638
|
+
readonly identityPreviewRequestBeta: IdentityPreviewRequestBeta
|
|
57639
|
+
}
|
|
57640
|
+
|
|
57226
57641
|
/**
|
|
57227
57642
|
* Request parameters for syncIdentityProfile operation in IdentityProfilesBetaApi.
|
|
57228
57643
|
* @export
|
|
@@ -57266,7 +57681,7 @@ export interface IdentityProfilesBetaApiUpdateIdentityProfileRequest {
|
|
|
57266
57681
|
*/
|
|
57267
57682
|
export class IdentityProfilesBetaApi extends BaseAPI {
|
|
57268
57683
|
/**
|
|
57269
|
-
* This creates an Identity Profile
|
|
57684
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
57270
57685
|
* @summary Create an Identity Profile
|
|
57271
57686
|
* @param {IdentityProfilesBetaApiCreateIdentityProfileRequest} requestParameters Request parameters.
|
|
57272
57687
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57313,18 +57728,6 @@ export class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
57313
57728
|
return IdentityProfilesBetaApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
57314
57729
|
}
|
|
57315
57730
|
|
|
57316
|
-
/**
|
|
57317
|
-
* 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. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
57318
|
-
* @summary Generate Identity Profile Preview
|
|
57319
|
-
* @param {IdentityProfilesBetaApiGenerateIdentityPreviewRequest} requestParameters Request parameters.
|
|
57320
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
57321
|
-
* @throws {RequiredError}
|
|
57322
|
-
* @memberof IdentityProfilesBetaApi
|
|
57323
|
-
*/
|
|
57324
|
-
public generateIdentityPreview(requestParameters: IdentityProfilesBetaApiGenerateIdentityPreviewRequest, axiosOptions?: AxiosRequestConfig) {
|
|
57325
|
-
return IdentityProfilesBetaApiFp(this.configuration).generateIdentityPreview(requestParameters.identityPreviewRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
57326
|
-
}
|
|
57327
|
-
|
|
57328
57731
|
/**
|
|
57329
57732
|
* 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.
|
|
57330
57733
|
* @summary Default identity attribute config
|
|
@@ -57338,7 +57741,7 @@ export class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
57338
57741
|
}
|
|
57339
57742
|
|
|
57340
57743
|
/**
|
|
57341
|
-
* This returns a single Identity Profile based on ID.
|
|
57744
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
57342
57745
|
* @summary Gets a single Identity Profile
|
|
57343
57746
|
* @param {IdentityProfilesBetaApiGetIdentityProfileRequest} requestParameters Request parameters.
|
|
57344
57747
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -57363,7 +57766,7 @@ export class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
57363
57766
|
|
|
57364
57767
|
/**
|
|
57365
57768
|
* This returns 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.
|
|
57366
|
-
* @summary Identity Profiles
|
|
57769
|
+
* @summary Identity Profiles List
|
|
57367
57770
|
* @param {IdentityProfilesBetaApiListIdentityProfilesRequest} requestParameters Request parameters.
|
|
57368
57771
|
* @param {*} [axiosOptions] Override http request option.
|
|
57369
57772
|
* @throws {RequiredError}
|
|
@@ -57373,6 +57776,18 @@ export class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
57373
57776
|
return IdentityProfilesBetaApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
57374
57777
|
}
|
|
57375
57778
|
|
|
57779
|
+
/**
|
|
57780
|
+
* 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.
|
|
57781
|
+
* @summary Generate Identity Profile Preview
|
|
57782
|
+
* @param {IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest} requestParameters Request parameters.
|
|
57783
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
57784
|
+
* @throws {RequiredError}
|
|
57785
|
+
* @memberof IdentityProfilesBetaApi
|
|
57786
|
+
*/
|
|
57787
|
+
public showGenerateIdentityPreview(requestParameters: IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest, axiosOptions?: AxiosRequestConfig) {
|
|
57788
|
+
return IdentityProfilesBetaApiFp(this.configuration).showGenerateIdentityPreview(requestParameters.identityPreviewRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
57789
|
+
}
|
|
57790
|
+
|
|
57376
57791
|
/**
|
|
57377
57792
|
* 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.
|
|
57378
57793
|
* @summary Process identities under profile
|
|
@@ -57386,7 +57801,7 @@ export class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
57386
57801
|
}
|
|
57387
57802
|
|
|
57388
57803
|
/**
|
|
57389
|
-
* This updates the specified Identity Profile.
|
|
57804
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
57390
57805
|
* @summary Update the Identity Profile
|
|
57391
57806
|
* @param {IdentityProfilesBetaApiUpdateIdentityProfileRequest} requestParameters Request parameters.
|
|
57392
57807
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59691,246 +60106,6 @@ export class ManagedClustersBetaApi extends BaseAPI {
|
|
|
59691
60106
|
}
|
|
59692
60107
|
|
|
59693
60108
|
|
|
59694
|
-
/**
|
|
59695
|
-
* ManualDiscoverApplicationsBetaApi - axios parameter creator
|
|
59696
|
-
* @export
|
|
59697
|
-
*/
|
|
59698
|
-
export const ManualDiscoverApplicationsBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
59699
|
-
return {
|
|
59700
|
-
/**
|
|
59701
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
59702
|
-
* @summary CSV Upload to discover applications
|
|
59703
|
-
* @param {any} csvFile
|
|
59704
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59705
|
-
* @throws {RequiredError}
|
|
59706
|
-
*/
|
|
59707
|
-
sendManualDiscoverApplicationsCsvTemplate: async (csvFile: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59708
|
-
// verify required parameter 'csvFile' is not null or undefined
|
|
59709
|
-
assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'csvFile', csvFile)
|
|
59710
|
-
const localVarPath = `/manual-discover-applications`;
|
|
59711
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59712
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59713
|
-
let baseOptions;
|
|
59714
|
-
if (configuration) {
|
|
59715
|
-
baseOptions = configuration.baseOptions;
|
|
59716
|
-
}
|
|
59717
|
-
|
|
59718
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
59719
|
-
const localVarHeaderParameter = {} as any;
|
|
59720
|
-
const localVarQueryParameter = {} as any;
|
|
59721
|
-
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
59722
|
-
|
|
59723
|
-
// authentication UserContextAuth required
|
|
59724
|
-
// oauth required
|
|
59725
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
59726
|
-
|
|
59727
|
-
// authentication UserContextAuth required
|
|
59728
|
-
// oauth required
|
|
59729
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
59730
|
-
|
|
59731
|
-
|
|
59732
|
-
if (csvFile !== undefined) {
|
|
59733
|
-
localVarFormParams.append('csvFile', csvFile as any);
|
|
59734
|
-
}
|
|
59735
|
-
|
|
59736
|
-
|
|
59737
|
-
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
59738
|
-
|
|
59739
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59740
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59741
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
59742
|
-
localVarRequestOptions.data = localVarFormParams;
|
|
59743
|
-
|
|
59744
|
-
return {
|
|
59745
|
-
url: toPathString(localVarUrlObj),
|
|
59746
|
-
axiosOptions: localVarRequestOptions,
|
|
59747
|
-
};
|
|
59748
|
-
},
|
|
59749
|
-
}
|
|
59750
|
-
};
|
|
59751
|
-
|
|
59752
|
-
/**
|
|
59753
|
-
* ManualDiscoverApplicationsBetaApi - functional programming interface
|
|
59754
|
-
* @export
|
|
59755
|
-
*/
|
|
59756
|
-
export const ManualDiscoverApplicationsBetaApiFp = function(configuration?: Configuration) {
|
|
59757
|
-
const localVarAxiosParamCreator = ManualDiscoverApplicationsBetaApiAxiosParamCreator(configuration)
|
|
59758
|
-
return {
|
|
59759
|
-
/**
|
|
59760
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
59761
|
-
* @summary CSV Upload to discover applications
|
|
59762
|
-
* @param {any} csvFile
|
|
59763
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59764
|
-
* @throws {RequiredError}
|
|
59765
|
-
*/
|
|
59766
|
-
async sendManualDiscoverApplicationsCsvTemplate(csvFile: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsBeta>> {
|
|
59767
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(csvFile, axiosOptions);
|
|
59768
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59769
|
-
},
|
|
59770
|
-
}
|
|
59771
|
-
};
|
|
59772
|
-
|
|
59773
|
-
/**
|
|
59774
|
-
* ManualDiscoverApplicationsBetaApi - factory interface
|
|
59775
|
-
* @export
|
|
59776
|
-
*/
|
|
59777
|
-
export const ManualDiscoverApplicationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
59778
|
-
const localVarFp = ManualDiscoverApplicationsBetaApiFp(configuration)
|
|
59779
|
-
return {
|
|
59780
|
-
/**
|
|
59781
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
59782
|
-
* @summary CSV Upload to discover applications
|
|
59783
|
-
* @param {any} csvFile
|
|
59784
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59785
|
-
* @throws {RequiredError}
|
|
59786
|
-
*/
|
|
59787
|
-
sendManualDiscoverApplicationsCsvTemplate(csvFile: any, axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsBeta> {
|
|
59788
|
-
return localVarFp.sendManualDiscoverApplicationsCsvTemplate(csvFile, axiosOptions).then((request) => request(axios, basePath));
|
|
59789
|
-
},
|
|
59790
|
-
};
|
|
59791
|
-
};
|
|
59792
|
-
|
|
59793
|
-
/**
|
|
59794
|
-
* Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ManualDiscoverApplicationsBetaApi.
|
|
59795
|
-
* @export
|
|
59796
|
-
* @interface ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest
|
|
59797
|
-
*/
|
|
59798
|
-
export interface ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest {
|
|
59799
|
-
/**
|
|
59800
|
-
*
|
|
59801
|
-
* @type {any}
|
|
59802
|
-
* @memberof ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplate
|
|
59803
|
-
*/
|
|
59804
|
-
readonly csvFile: any
|
|
59805
|
-
}
|
|
59806
|
-
|
|
59807
|
-
/**
|
|
59808
|
-
* ManualDiscoverApplicationsBetaApi - object-oriented interface
|
|
59809
|
-
* @export
|
|
59810
|
-
* @class ManualDiscoverApplicationsBetaApi
|
|
59811
|
-
* @extends {BaseAPI}
|
|
59812
|
-
*/
|
|
59813
|
-
export class ManualDiscoverApplicationsBetaApi extends BaseAPI {
|
|
59814
|
-
/**
|
|
59815
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
59816
|
-
* @summary CSV Upload to discover applications
|
|
59817
|
-
* @param {ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters.
|
|
59818
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59819
|
-
* @throws {RequiredError}
|
|
59820
|
-
* @memberof ManualDiscoverApplicationsBetaApi
|
|
59821
|
-
*/
|
|
59822
|
-
public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: AxiosRequestConfig) {
|
|
59823
|
-
return ManualDiscoverApplicationsBetaApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
59824
|
-
}
|
|
59825
|
-
}
|
|
59826
|
-
|
|
59827
|
-
|
|
59828
|
-
/**
|
|
59829
|
-
* ManualDiscoverApplicationsTemplateBetaApi - axios parameter creator
|
|
59830
|
-
* @export
|
|
59831
|
-
*/
|
|
59832
|
-
export const ManualDiscoverApplicationsTemplateBetaApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
59833
|
-
return {
|
|
59834
|
-
/**
|
|
59835
|
-
* Allows the user to download an example CSV file with two columns `application_name` and `domain`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'.
|
|
59836
|
-
* @summary CSV template download for discovery
|
|
59837
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59838
|
-
* @throws {RequiredError}
|
|
59839
|
-
*/
|
|
59840
|
-
getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59841
|
-
const localVarPath = `/manual-discover-applications-template`;
|
|
59842
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59843
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59844
|
-
let baseOptions;
|
|
59845
|
-
if (configuration) {
|
|
59846
|
-
baseOptions = configuration.baseOptions;
|
|
59847
|
-
}
|
|
59848
|
-
|
|
59849
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
59850
|
-
const localVarHeaderParameter = {} as any;
|
|
59851
|
-
const localVarQueryParameter = {} as any;
|
|
59852
|
-
|
|
59853
|
-
// authentication UserContextAuth required
|
|
59854
|
-
// oauth required
|
|
59855
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
59856
|
-
|
|
59857
|
-
// authentication UserContextAuth required
|
|
59858
|
-
// oauth required
|
|
59859
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
59860
|
-
|
|
59861
|
-
|
|
59862
|
-
|
|
59863
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59864
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59865
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
59866
|
-
|
|
59867
|
-
return {
|
|
59868
|
-
url: toPathString(localVarUrlObj),
|
|
59869
|
-
axiosOptions: localVarRequestOptions,
|
|
59870
|
-
};
|
|
59871
|
-
},
|
|
59872
|
-
}
|
|
59873
|
-
};
|
|
59874
|
-
|
|
59875
|
-
/**
|
|
59876
|
-
* ManualDiscoverApplicationsTemplateBetaApi - functional programming interface
|
|
59877
|
-
* @export
|
|
59878
|
-
*/
|
|
59879
|
-
export const ManualDiscoverApplicationsTemplateBetaApiFp = function(configuration?: Configuration) {
|
|
59880
|
-
const localVarAxiosParamCreator = ManualDiscoverApplicationsTemplateBetaApiAxiosParamCreator(configuration)
|
|
59881
|
-
return {
|
|
59882
|
-
/**
|
|
59883
|
-
* Allows the user to download an example CSV file with two columns `application_name` and `domain`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'.
|
|
59884
|
-
* @summary CSV template download for discovery
|
|
59885
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59886
|
-
* @throws {RequiredError}
|
|
59887
|
-
*/
|
|
59888
|
-
async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsTemplateBeta>> {
|
|
59889
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions);
|
|
59890
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59891
|
-
},
|
|
59892
|
-
}
|
|
59893
|
-
};
|
|
59894
|
-
|
|
59895
|
-
/**
|
|
59896
|
-
* ManualDiscoverApplicationsTemplateBetaApi - factory interface
|
|
59897
|
-
* @export
|
|
59898
|
-
*/
|
|
59899
|
-
export const ManualDiscoverApplicationsTemplateBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
59900
|
-
const localVarFp = ManualDiscoverApplicationsTemplateBetaApiFp(configuration)
|
|
59901
|
-
return {
|
|
59902
|
-
/**
|
|
59903
|
-
* Allows the user to download an example CSV file with two columns `application_name` and `domain`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'.
|
|
59904
|
-
* @summary CSV template download for discovery
|
|
59905
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59906
|
-
* @throws {RequiredError}
|
|
59907
|
-
*/
|
|
59908
|
-
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsTemplateBeta> {
|
|
59909
|
-
return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath));
|
|
59910
|
-
},
|
|
59911
|
-
};
|
|
59912
|
-
};
|
|
59913
|
-
|
|
59914
|
-
/**
|
|
59915
|
-
* ManualDiscoverApplicationsTemplateBetaApi - object-oriented interface
|
|
59916
|
-
* @export
|
|
59917
|
-
* @class ManualDiscoverApplicationsTemplateBetaApi
|
|
59918
|
-
* @extends {BaseAPI}
|
|
59919
|
-
*/
|
|
59920
|
-
export class ManualDiscoverApplicationsTemplateBetaApi extends BaseAPI {
|
|
59921
|
-
/**
|
|
59922
|
-
* Allows the user to download an example CSV file with two columns `application_name` and `domain`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'.
|
|
59923
|
-
* @summary CSV template download for discovery
|
|
59924
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59925
|
-
* @throws {RequiredError}
|
|
59926
|
-
* @memberof ManualDiscoverApplicationsTemplateBetaApi
|
|
59927
|
-
*/
|
|
59928
|
-
public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig) {
|
|
59929
|
-
return ManualDiscoverApplicationsTemplateBetaApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
59930
|
-
}
|
|
59931
|
-
}
|
|
59932
|
-
|
|
59933
|
-
|
|
59934
60109
|
/**
|
|
59935
60110
|
* NonEmployeeLifecycleManagementBetaApi - axios parameter creator
|
|
59936
60111
|
* @export
|
|
@@ -84480,44 +84655,6 @@ export const VendorConnectorMappingsBetaApiAxiosParamCreator = function (configu
|
|
|
84480
84655
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
84481
84656
|
localVarRequestOptions.data = serializeDataIfNeeded(vendorConnectorMappingBeta, localVarRequestOptions, configuration)
|
|
84482
84657
|
|
|
84483
|
-
return {
|
|
84484
|
-
url: toPathString(localVarUrlObj),
|
|
84485
|
-
axiosOptions: localVarRequestOptions,
|
|
84486
|
-
};
|
|
84487
|
-
},
|
|
84488
|
-
/**
|
|
84489
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
84490
|
-
* @summary List vendor connector mappings
|
|
84491
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
84492
|
-
* @throws {RequiredError}
|
|
84493
|
-
*/
|
|
84494
|
-
getVendorConnectorMappings: async (axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
84495
|
-
const localVarPath = `/vendor-connector-mappings`;
|
|
84496
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84497
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
84498
|
-
let baseOptions;
|
|
84499
|
-
if (configuration) {
|
|
84500
|
-
baseOptions = configuration.baseOptions;
|
|
84501
|
-
}
|
|
84502
|
-
|
|
84503
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
84504
|
-
const localVarHeaderParameter = {} as any;
|
|
84505
|
-
const localVarQueryParameter = {} as any;
|
|
84506
|
-
|
|
84507
|
-
// authentication UserContextAuth required
|
|
84508
|
-
// oauth required
|
|
84509
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
84510
|
-
|
|
84511
|
-
// authentication UserContextAuth required
|
|
84512
|
-
// oauth required
|
|
84513
|
-
await setOAuthToObject(localVarHeaderParameter, "UserContextAuth", [], configuration)
|
|
84514
|
-
|
|
84515
|
-
|
|
84516
|
-
|
|
84517
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
84518
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84519
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
84520
|
-
|
|
84521
84658
|
return {
|
|
84522
84659
|
url: toPathString(localVarUrlObj),
|
|
84523
84660
|
axiosOptions: localVarRequestOptions,
|
|
@@ -84555,16 +84692,6 @@ export const VendorConnectorMappingsBetaApiFp = function(configuration?: Configu
|
|
|
84555
84692
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVendorConnectorMapping(vendorConnectorMappingBeta, axiosOptions);
|
|
84556
84693
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
84557
84694
|
},
|
|
84558
|
-
/**
|
|
84559
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
84560
|
-
* @summary List vendor connector mappings
|
|
84561
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
84562
|
-
* @throws {RequiredError}
|
|
84563
|
-
*/
|
|
84564
|
-
async getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMappingBeta>>> {
|
|
84565
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getVendorConnectorMappings(axiosOptions);
|
|
84566
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
84567
|
-
},
|
|
84568
84695
|
}
|
|
84569
84696
|
};
|
|
84570
84697
|
|
|
@@ -84595,15 +84722,6 @@ export const VendorConnectorMappingsBetaApiFactory = function (configuration?: C
|
|
|
84595
84722
|
deleteVendorConnectorMapping(vendorConnectorMappingBeta: VendorConnectorMappingBeta, axiosOptions?: any): AxiosPromise<DeleteVendorConnectorMapping200ResponseBeta> {
|
|
84596
84723
|
return localVarFp.deleteVendorConnectorMapping(vendorConnectorMappingBeta, axiosOptions).then((request) => request(axios, basePath));
|
|
84597
84724
|
},
|
|
84598
|
-
/**
|
|
84599
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
84600
|
-
* @summary List vendor connector mappings
|
|
84601
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
84602
|
-
* @throws {RequiredError}
|
|
84603
|
-
*/
|
|
84604
|
-
getVendorConnectorMappings(axiosOptions?: any): AxiosPromise<Array<VendorConnectorMappingBeta>> {
|
|
84605
|
-
return localVarFp.getVendorConnectorMappings(axiosOptions).then((request) => request(axios, basePath));
|
|
84606
|
-
},
|
|
84607
84725
|
};
|
|
84608
84726
|
};
|
|
84609
84727
|
|
|
@@ -84665,17 +84783,6 @@ export class VendorConnectorMappingsBetaApi extends BaseAPI {
|
|
|
84665
84783
|
public deleteVendorConnectorMapping(requestParameters: VendorConnectorMappingsBetaApiDeleteVendorConnectorMappingRequest, axiosOptions?: AxiosRequestConfig) {
|
|
84666
84784
|
return VendorConnectorMappingsBetaApiFp(this.configuration).deleteVendorConnectorMapping(requestParameters.vendorConnectorMappingBeta, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
84667
84785
|
}
|
|
84668
|
-
|
|
84669
|
-
/**
|
|
84670
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
84671
|
-
* @summary List vendor connector mappings
|
|
84672
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
84673
|
-
* @throws {RequiredError}
|
|
84674
|
-
* @memberof VendorConnectorMappingsBetaApi
|
|
84675
|
-
*/
|
|
84676
|
-
public getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig) {
|
|
84677
|
-
return VendorConnectorMappingsBetaApiFp(this.configuration).getVendorConnectorMappings(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
84678
|
-
}
|
|
84679
84786
|
}
|
|
84680
84787
|
|
|
84681
84788
|
|
|
@@ -84929,7 +85036,7 @@ export const WorkItemsBetaApiAxiosParamCreator = function (configuration?: Confi
|
|
|
84929
85036
|
* @throws {RequiredError}
|
|
84930
85037
|
*/
|
|
84931
85038
|
getCountCompletedWorkItems: async (ownerId?: string, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
84932
|
-
const localVarPath = `/work-items/count
|
|
85039
|
+
const localVarPath = `/work-items/completed/count`;
|
|
84933
85040
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84934
85041
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
84935
85042
|
let baseOptions;
|