sailpoint-api-client 1.3.5 → 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 +1250 -1143
- package/beta/common.ts +9 -2
- package/beta/package.json +1 -1
- package/configuration.ts +1 -0
- package/dist/beta/api.d.ts +637 -566
- package/dist/beta/api.js +1160 -1132
- 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 +2490 -249
- package/dist/v3/api.js +3029 -833
- 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 +4264 -1007
- package/v3/common.ts +9 -2
- package/v3/package.json +1 -1
package/dist/beta/api.d.ts
CHANGED
|
@@ -151,11 +151,29 @@ export interface AccessItemAccessProfileResponseBeta {
|
|
|
151
151
|
*/
|
|
152
152
|
'entitlementCount'?: string;
|
|
153
153
|
/**
|
|
154
|
-
* the name of
|
|
154
|
+
* the name of
|
|
155
155
|
* @type {string}
|
|
156
156
|
* @memberof AccessItemAccessProfileResponseBeta
|
|
157
157
|
*/
|
|
158
158
|
'appDisplayName'?: string;
|
|
159
|
+
/**
|
|
160
|
+
* the date the access profile is no longer assigned to the specified identity
|
|
161
|
+
* @type {string}
|
|
162
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
163
|
+
*/
|
|
164
|
+
'removeDate'?: string;
|
|
165
|
+
/**
|
|
166
|
+
* indicates whether the access profile is standalone
|
|
167
|
+
* @type {boolean}
|
|
168
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
169
|
+
*/
|
|
170
|
+
'standalone': boolean;
|
|
171
|
+
/**
|
|
172
|
+
* indicates whether the access profile is
|
|
173
|
+
* @type {boolean}
|
|
174
|
+
* @memberof AccessItemAccessProfileResponseBeta
|
|
175
|
+
*/
|
|
176
|
+
'revocable': boolean;
|
|
159
177
|
}
|
|
160
178
|
/**
|
|
161
179
|
*
|
|
@@ -225,7 +243,7 @@ export interface AccessItemAppResponseBeta {
|
|
|
225
243
|
*/
|
|
226
244
|
'id'?: string;
|
|
227
245
|
/**
|
|
228
|
-
* the access
|
|
246
|
+
* the access item display name
|
|
229
247
|
* @type {string}
|
|
230
248
|
* @memberof AccessItemAppResponseBeta
|
|
231
249
|
*/
|
|
@@ -236,6 +254,12 @@ export interface AccessItemAppResponseBeta {
|
|
|
236
254
|
* @memberof AccessItemAppResponseBeta
|
|
237
255
|
*/
|
|
238
256
|
'sourceName'?: string;
|
|
257
|
+
/**
|
|
258
|
+
* the app role id
|
|
259
|
+
* @type {string}
|
|
260
|
+
* @memberof AccessItemAppResponseBeta
|
|
261
|
+
*/
|
|
262
|
+
'appRoleId'?: string;
|
|
239
263
|
}
|
|
240
264
|
/**
|
|
241
265
|
* Identity who approved the access item request.
|
|
@@ -404,6 +428,24 @@ export interface AccessItemEntitlementResponseBeta {
|
|
|
404
428
|
* @memberof AccessItemEntitlementResponseBeta
|
|
405
429
|
*/
|
|
406
430
|
'displayName'?: string;
|
|
431
|
+
/**
|
|
432
|
+
* indicates whether the entitlement is standalone
|
|
433
|
+
* @type {boolean}
|
|
434
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
435
|
+
*/
|
|
436
|
+
'standalone': boolean;
|
|
437
|
+
/**
|
|
438
|
+
* indicates whether the entitlement is privileged
|
|
439
|
+
* @type {boolean}
|
|
440
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
441
|
+
*/
|
|
442
|
+
'privileged': boolean;
|
|
443
|
+
/**
|
|
444
|
+
* indicates whether the entitlement is cloud governed
|
|
445
|
+
* @type {boolean}
|
|
446
|
+
* @memberof AccessItemEntitlementResponseBeta
|
|
447
|
+
*/
|
|
448
|
+
'cloudGoverned': boolean;
|
|
407
449
|
}
|
|
408
450
|
/**
|
|
409
451
|
* Access item owner\'s identity.
|
|
@@ -648,6 +690,18 @@ export interface AccessItemRoleResponseBeta {
|
|
|
648
690
|
* @memberof AccessItemRoleResponseBeta
|
|
649
691
|
*/
|
|
650
692
|
'sourceName'?: string;
|
|
693
|
+
/**
|
|
694
|
+
* the date the role is no longer assigned to the specified identity
|
|
695
|
+
* @type {string}
|
|
696
|
+
* @memberof AccessItemRoleResponseBeta
|
|
697
|
+
*/
|
|
698
|
+
'removeDate'?: string;
|
|
699
|
+
/**
|
|
700
|
+
* indicates whether the role is revocable
|
|
701
|
+
* @type {boolean}
|
|
702
|
+
* @memberof AccessItemRoleResponseBeta
|
|
703
|
+
*/
|
|
704
|
+
'revocable': boolean;
|
|
651
705
|
}
|
|
652
706
|
/**
|
|
653
707
|
*
|
|
@@ -7098,12 +7152,6 @@ export interface CompletedApprovalBeta {
|
|
|
7098
7152
|
'clientMetadata'?: {
|
|
7099
7153
|
[key: string]: string;
|
|
7100
7154
|
};
|
|
7101
|
-
/**
|
|
7102
|
-
* Information about the requested accounts
|
|
7103
|
-
* @type {string}
|
|
7104
|
-
* @memberof CompletedApprovalBeta
|
|
7105
|
-
*/
|
|
7106
|
-
'requestedAccounts'?: string | null;
|
|
7107
7155
|
}
|
|
7108
7156
|
/**
|
|
7109
7157
|
* 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.
|
|
@@ -10816,7 +10864,7 @@ export interface FormElementDynamicDataSourceBeta {
|
|
|
10816
10864
|
*/
|
|
10817
10865
|
'config'?: FormElementDynamicDataSourceConfigBeta;
|
|
10818
10866
|
/**
|
|
10819
|
-
* DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch
|
|
10867
|
+
* DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput
|
|
10820
10868
|
* @type {string}
|
|
10821
10869
|
* @memberof FormElementDynamicDataSourceBeta
|
|
10822
10870
|
*/
|
|
@@ -10826,6 +10874,7 @@ export declare const FormElementDynamicDataSourceBetaDataSourceTypeEnum: {
|
|
|
10826
10874
|
readonly Static: "STATIC";
|
|
10827
10875
|
readonly Internal: "INTERNAL";
|
|
10828
10876
|
readonly Search: "SEARCH";
|
|
10877
|
+
readonly FormInput: "FORM_INPUT";
|
|
10829
10878
|
};
|
|
10830
10879
|
export type FormElementDynamicDataSourceBetaDataSourceTypeEnum = typeof FormElementDynamicDataSourceBetaDataSourceTypeEnum[keyof typeof FormElementDynamicDataSourceBetaDataSourceTypeEnum];
|
|
10831
10880
|
/**
|
|
@@ -11704,25 +11753,6 @@ export interface GenerateRandomStringBeta {
|
|
|
11704
11753
|
*/
|
|
11705
11754
|
'requiresPeriodicRefresh'?: boolean;
|
|
11706
11755
|
}
|
|
11707
|
-
/**
|
|
11708
|
-
*
|
|
11709
|
-
* @export
|
|
11710
|
-
* @interface GenericRuleBeta
|
|
11711
|
-
*/
|
|
11712
|
-
export interface GenericRuleBeta {
|
|
11713
|
-
/**
|
|
11714
|
-
* This is the name of the Generic rule that needs to be invoked by the transform
|
|
11715
|
-
* @type {string}
|
|
11716
|
-
* @memberof GenericRuleBeta
|
|
11717
|
-
*/
|
|
11718
|
-
'name': string;
|
|
11719
|
-
/**
|
|
11720
|
-
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
11721
|
-
* @type {boolean}
|
|
11722
|
-
* @memberof GenericRuleBeta
|
|
11723
|
-
*/
|
|
11724
|
-
'requiresPeriodicRefresh'?: boolean;
|
|
11725
|
-
}
|
|
11726
11756
|
/**
|
|
11727
11757
|
* @type GetActiveCampaigns200ResponseInnerBeta
|
|
11728
11758
|
* @export
|
|
@@ -13911,6 +13941,24 @@ export interface IdentityWithNewAccessBeta {
|
|
|
13911
13941
|
*/
|
|
13912
13942
|
'accessRefs': Array<IdentityWithNewAccessAccessRefsInnerBeta>;
|
|
13913
13943
|
}
|
|
13944
|
+
/**
|
|
13945
|
+
* 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.
|
|
13946
|
+
* @export
|
|
13947
|
+
* @interface ImportAccountsRequest1Beta
|
|
13948
|
+
*/
|
|
13949
|
+
export interface ImportAccountsRequest1Beta {
|
|
13950
|
+
/**
|
|
13951
|
+
* Use this flag to reprocess every account whether or not the data has changed.
|
|
13952
|
+
* @type {string}
|
|
13953
|
+
* @memberof ImportAccountsRequest1Beta
|
|
13954
|
+
*/
|
|
13955
|
+
'disableOptimization'?: ImportAccountsRequest1BetaDisableOptimizationEnum;
|
|
13956
|
+
}
|
|
13957
|
+
export declare const ImportAccountsRequest1BetaDisableOptimizationEnum: {
|
|
13958
|
+
readonly True: "true";
|
|
13959
|
+
readonly False: "false";
|
|
13960
|
+
};
|
|
13961
|
+
export type ImportAccountsRequest1BetaDisableOptimizationEnum = typeof ImportAccountsRequest1BetaDisableOptimizationEnum[keyof typeof ImportAccountsRequest1BetaDisableOptimizationEnum];
|
|
13914
13962
|
/**
|
|
13915
13963
|
*
|
|
13916
13964
|
* @export
|
|
@@ -13928,8 +13976,13 @@ export interface ImportAccountsRequestBeta {
|
|
|
13928
13976
|
* @type {string}
|
|
13929
13977
|
* @memberof ImportAccountsRequestBeta
|
|
13930
13978
|
*/
|
|
13931
|
-
'disableOptimization'?:
|
|
13979
|
+
'disableOptimization'?: ImportAccountsRequestBetaDisableOptimizationEnum;
|
|
13932
13980
|
}
|
|
13981
|
+
export declare const ImportAccountsRequestBetaDisableOptimizationEnum: {
|
|
13982
|
+
readonly True: "true";
|
|
13983
|
+
readonly False: "false";
|
|
13984
|
+
};
|
|
13985
|
+
export type ImportAccountsRequestBetaDisableOptimizationEnum = typeof ImportAccountsRequestBetaDisableOptimizationEnum[keyof typeof ImportAccountsRequestBetaDisableOptimizationEnum];
|
|
13933
13986
|
/**
|
|
13934
13987
|
*
|
|
13935
13988
|
* @export
|
|
@@ -15985,11 +16038,11 @@ export interface ManualDiscoverApplicationsTemplateBeta {
|
|
|
15985
16038
|
*/
|
|
15986
16039
|
'application_name'?: string;
|
|
15987
16040
|
/**
|
|
15988
|
-
* Description of the example application
|
|
16041
|
+
* Description of the example application.
|
|
15989
16042
|
* @type {string}
|
|
15990
16043
|
* @memberof ManualDiscoverApplicationsTemplateBeta
|
|
15991
16044
|
*/
|
|
15992
|
-
'
|
|
16045
|
+
'description'?: string;
|
|
15993
16046
|
}
|
|
15994
16047
|
/**
|
|
15995
16048
|
*
|
|
@@ -23291,7 +23344,7 @@ export interface RoleTargetDtoBeta {
|
|
|
23291
23344
|
* @type RuleBeta
|
|
23292
23345
|
* @export
|
|
23293
23346
|
*/
|
|
23294
|
-
export type RuleBeta = GenerateRandomStringBeta |
|
|
23347
|
+
export type RuleBeta = GenerateRandomStringBeta | GetReferenceIdentityAttributeBeta | TransformRuleBeta;
|
|
23295
23348
|
/**
|
|
23296
23349
|
*
|
|
23297
23350
|
* @export
|
|
@@ -24451,19 +24504,6 @@ export declare const SendAccountVerificationRequestBetaViaEnum: {
|
|
|
24451
24504
|
readonly LinkPersonal: "LINK_PERSONAL";
|
|
24452
24505
|
};
|
|
24453
24506
|
export type SendAccountVerificationRequestBetaViaEnum = typeof SendAccountVerificationRequestBetaViaEnum[keyof typeof SendAccountVerificationRequestBetaViaEnum];
|
|
24454
|
-
/**
|
|
24455
|
-
*
|
|
24456
|
-
* @export
|
|
24457
|
-
* @interface SendManualDiscoverApplicationsCsvTemplateRequestBeta
|
|
24458
|
-
*/
|
|
24459
|
-
export interface SendManualDiscoverApplicationsCsvTemplateRequestBeta {
|
|
24460
|
-
/**
|
|
24461
|
-
*
|
|
24462
|
-
* @type {any}
|
|
24463
|
-
* @memberof SendManualDiscoverApplicationsCsvTemplateRequestBeta
|
|
24464
|
-
*/
|
|
24465
|
-
'csvFile': any;
|
|
24466
|
-
}
|
|
24467
24507
|
/**
|
|
24468
24508
|
*
|
|
24469
24509
|
* @export
|
|
@@ -25747,13 +25787,13 @@ export interface SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta {
|
|
|
25747
25787
|
*/
|
|
25748
25788
|
export interface Source1Beta {
|
|
25749
25789
|
/**
|
|
25750
|
-
*
|
|
25790
|
+
* Attribute mapping type.
|
|
25751
25791
|
* @type {string}
|
|
25752
25792
|
* @memberof Source1Beta
|
|
25753
25793
|
*/
|
|
25754
25794
|
'type'?: string;
|
|
25755
25795
|
/**
|
|
25756
|
-
*
|
|
25796
|
+
* Attribute mapping properties.
|
|
25757
25797
|
* @type {object}
|
|
25758
25798
|
* @memberof Source1Beta
|
|
25759
25799
|
*/
|
|
@@ -29138,6 +29178,25 @@ export declare const TransformReadBetaTypeEnum: {
|
|
|
29138
29178
|
readonly Rfc5646: "rfc5646";
|
|
29139
29179
|
};
|
|
29140
29180
|
export type TransformReadBetaTypeEnum = typeof TransformReadBetaTypeEnum[keyof typeof TransformReadBetaTypeEnum];
|
|
29181
|
+
/**
|
|
29182
|
+
*
|
|
29183
|
+
* @export
|
|
29184
|
+
* @interface TransformRuleBeta
|
|
29185
|
+
*/
|
|
29186
|
+
export interface TransformRuleBeta {
|
|
29187
|
+
/**
|
|
29188
|
+
* This is the name of the Transform rule that needs to be invoked by the transform
|
|
29189
|
+
* @type {string}
|
|
29190
|
+
* @memberof TransformRuleBeta
|
|
29191
|
+
*/
|
|
29192
|
+
'name': string;
|
|
29193
|
+
/**
|
|
29194
|
+
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
29195
|
+
* @type {boolean}
|
|
29196
|
+
* @memberof TransformRuleBeta
|
|
29197
|
+
*/
|
|
29198
|
+
'requiresPeriodicRefresh'?: boolean;
|
|
29199
|
+
}
|
|
29141
29200
|
/**
|
|
29142
29201
|
*
|
|
29143
29202
|
* @export
|
|
@@ -31333,13 +31392,13 @@ export declare const AccessProfilesBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
31333
31392
|
*/
|
|
31334
31393
|
getAccessProfile: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31335
31394
|
/**
|
|
31336
|
-
*
|
|
31395
|
+
* 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.
|
|
31337
31396
|
* @summary List Access Profile\'s Entitlements
|
|
31338
|
-
* @param {string} id ID of the containing
|
|
31397
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
31339
31398
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31340
31399
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31341
31400
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31342
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
31401
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
31343
31402
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
31344
31403
|
* @param {*} [axiosOptions] Override http request option.
|
|
31345
31404
|
* @throws {RequiredError}
|
|
@@ -31348,7 +31407,7 @@ export declare const AccessProfilesBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
31348
31407
|
/**
|
|
31349
31408
|
* 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.
|
|
31350
31409
|
* @summary List Access Profiles
|
|
31351
|
-
* @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
|
|
31410
|
+
* @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.
|
|
31352
31411
|
* @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.
|
|
31353
31412
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31354
31413
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31416,13 +31475,13 @@ export declare const AccessProfilesBetaApiFp: (configuration?: Configuration) =>
|
|
|
31416
31475
|
*/
|
|
31417
31476
|
getAccessProfile(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileBeta>>;
|
|
31418
31477
|
/**
|
|
31419
|
-
*
|
|
31478
|
+
* 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.
|
|
31420
31479
|
* @summary List Access Profile\'s Entitlements
|
|
31421
|
-
* @param {string} id ID of the containing
|
|
31480
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
31422
31481
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31423
31482
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31424
31483
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31425
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
31484
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
31426
31485
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
31427
31486
|
* @param {*} [axiosOptions] Override http request option.
|
|
31428
31487
|
* @throws {RequiredError}
|
|
@@ -31431,7 +31490,7 @@ export declare const AccessProfilesBetaApiFp: (configuration?: Configuration) =>
|
|
|
31431
31490
|
/**
|
|
31432
31491
|
* 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.
|
|
31433
31492
|
* @summary List Access Profiles
|
|
31434
|
-
* @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
|
|
31493
|
+
* @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.
|
|
31435
31494
|
* @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.
|
|
31436
31495
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31437
31496
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31499,13 +31558,13 @@ export declare const AccessProfilesBetaApiFactory: (configuration?: Configuratio
|
|
|
31499
31558
|
*/
|
|
31500
31559
|
getAccessProfile(id: string, axiosOptions?: any): AxiosPromise<AccessProfileBeta>;
|
|
31501
31560
|
/**
|
|
31502
|
-
*
|
|
31561
|
+
* 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.
|
|
31503
31562
|
* @summary List Access Profile\'s Entitlements
|
|
31504
|
-
* @param {string} id ID of the containing
|
|
31563
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
31505
31564
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31506
31565
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31507
31566
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31508
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
31567
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
31509
31568
|
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
31510
31569
|
* @param {*} [axiosOptions] Override http request option.
|
|
31511
31570
|
* @throws {RequiredError}
|
|
@@ -31514,7 +31573,7 @@ export declare const AccessProfilesBetaApiFactory: (configuration?: Configuratio
|
|
|
31514
31573
|
/**
|
|
31515
31574
|
* 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.
|
|
31516
31575
|
* @summary List Access Profiles
|
|
31517
|
-
* @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
|
|
31576
|
+
* @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.
|
|
31518
31577
|
* @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.
|
|
31519
31578
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
31520
31579
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31603,7 +31662,7 @@ export interface AccessProfilesBetaApiGetAccessProfileRequest {
|
|
|
31603
31662
|
*/
|
|
31604
31663
|
export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
31605
31664
|
/**
|
|
31606
|
-
* ID of the containing
|
|
31665
|
+
* ID of the access profile containing the entitlements.
|
|
31607
31666
|
* @type {string}
|
|
31608
31667
|
* @memberof AccessProfilesBetaApiGetAccessProfileEntitlements
|
|
31609
31668
|
*/
|
|
@@ -31627,7 +31686,7 @@ export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
|
31627
31686
|
*/
|
|
31628
31687
|
readonly count?: boolean;
|
|
31629
31688
|
/**
|
|
31630
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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*
|
|
31689
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://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.
|
|
31631
31690
|
* @type {string}
|
|
31632
31691
|
* @memberof AccessProfilesBetaApiGetAccessProfileEntitlements
|
|
31633
31692
|
*/
|
|
@@ -31646,7 +31705,7 @@ export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest {
|
|
|
31646
31705
|
*/
|
|
31647
31706
|
export interface AccessProfilesBetaApiListAccessProfilesRequest {
|
|
31648
31707
|
/**
|
|
31649
|
-
* 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
|
|
31708
|
+
* 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.
|
|
31650
31709
|
* @type {string}
|
|
31651
31710
|
* @memberof AccessProfilesBetaApiListAccessProfiles
|
|
31652
31711
|
*/
|
|
@@ -31770,7 +31829,7 @@ export declare class AccessProfilesBetaApi extends BaseAPI {
|
|
|
31770
31829
|
*/
|
|
31771
31830
|
getAccessProfile(requestParameters: AccessProfilesBetaApiGetAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBeta, any>>;
|
|
31772
31831
|
/**
|
|
31773
|
-
*
|
|
31832
|
+
* 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.
|
|
31774
31833
|
* @summary List Access Profile\'s Entitlements
|
|
31775
31834
|
* @param {AccessProfilesBetaApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters.
|
|
31776
31835
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33163,7 +33222,7 @@ export declare const AccountsBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
33163
33222
|
*/
|
|
33164
33223
|
listAccounts: (detailLevel?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33165
33224
|
/**
|
|
33166
|
-
* Use this API to update an account with a PUT request.
|
|
33225
|
+
* 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.**
|
|
33167
33226
|
* @summary Update Account
|
|
33168
33227
|
* @param {string} id Account ID.
|
|
33169
33228
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -33189,14 +33248,14 @@ export declare const AccountsBetaApiAxiosParamCreator: (configuration?: Configur
|
|
|
33189
33248
|
*/
|
|
33190
33249
|
unlockAccount: (id: string, accountUnlockRequestBeta: AccountUnlockRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33191
33250
|
/**
|
|
33192
|
-
*
|
|
33251
|
+
* 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.
|
|
33193
33252
|
* @summary Update Account
|
|
33194
33253
|
* @param {string} id Account ID.
|
|
33195
|
-
* @param {Array<
|
|
33254
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
33196
33255
|
* @param {*} [axiosOptions] Override http request option.
|
|
33197
33256
|
* @throws {RequiredError}
|
|
33198
33257
|
*/
|
|
33199
|
-
updateAccount: (id: string,
|
|
33258
|
+
updateAccount: (id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33200
33259
|
};
|
|
33201
33260
|
/**
|
|
33202
33261
|
* AccountsBetaApi - functional programming interface
|
|
@@ -33310,7 +33369,7 @@ export declare const AccountsBetaApiFp: (configuration?: Configuration) => {
|
|
|
33310
33369
|
*/
|
|
33311
33370
|
listAccounts(detailLevel?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountBeta>>>;
|
|
33312
33371
|
/**
|
|
33313
|
-
* Use this API to update an account with a PUT request.
|
|
33372
|
+
* 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.**
|
|
33314
33373
|
* @summary Update Account
|
|
33315
33374
|
* @param {string} id Account ID.
|
|
33316
33375
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -33336,14 +33395,14 @@ export declare const AccountsBetaApiFp: (configuration?: Configuration) => {
|
|
|
33336
33395
|
*/
|
|
33337
33396
|
unlockAccount(id: string, accountUnlockRequestBeta: AccountUnlockRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountsAsyncResultBeta>>;
|
|
33338
33397
|
/**
|
|
33339
|
-
*
|
|
33398
|
+
* 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.
|
|
33340
33399
|
* @summary Update Account
|
|
33341
33400
|
* @param {string} id Account ID.
|
|
33342
|
-
* @param {Array<
|
|
33401
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
33343
33402
|
* @param {*} [axiosOptions] Override http request option.
|
|
33344
33403
|
* @throws {RequiredError}
|
|
33345
33404
|
*/
|
|
33346
|
-
updateAccount(id: string,
|
|
33405
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
33347
33406
|
};
|
|
33348
33407
|
/**
|
|
33349
33408
|
* AccountsBetaApi - factory interface
|
|
@@ -33457,7 +33516,7 @@ export declare const AccountsBetaApiFactory: (configuration?: Configuration, bas
|
|
|
33457
33516
|
*/
|
|
33458
33517
|
listAccounts(detailLevel?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<AccountBeta>>;
|
|
33459
33518
|
/**
|
|
33460
|
-
* Use this API to update an account with a PUT request.
|
|
33519
|
+
* 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.**
|
|
33461
33520
|
* @summary Update Account
|
|
33462
33521
|
* @param {string} id Account ID.
|
|
33463
33522
|
* @param {AccountAttributesBeta} accountAttributesBeta
|
|
@@ -33483,14 +33542,14 @@ export declare const AccountsBetaApiFactory: (configuration?: Configuration, bas
|
|
|
33483
33542
|
*/
|
|
33484
33543
|
unlockAccount(id: string, accountUnlockRequestBeta: AccountUnlockRequestBeta, axiosOptions?: any): AxiosPromise<AccountsAsyncResultBeta>;
|
|
33485
33544
|
/**
|
|
33486
|
-
*
|
|
33545
|
+
* 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.
|
|
33487
33546
|
* @summary Update Account
|
|
33488
33547
|
* @param {string} id Account ID.
|
|
33489
|
-
* @param {Array<
|
|
33548
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
33490
33549
|
* @param {*} [axiosOptions] Override http request option.
|
|
33491
33550
|
* @throws {RequiredError}
|
|
33492
33551
|
*/
|
|
33493
|
-
updateAccount(id: string,
|
|
33552
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: any): AxiosPromise<object>;
|
|
33494
33553
|
};
|
|
33495
33554
|
/**
|
|
33496
33555
|
* Request parameters for createAccount operation in AccountsBetaApi.
|
|
@@ -33773,10 +33832,10 @@ export interface AccountsBetaApiUpdateAccountRequest {
|
|
|
33773
33832
|
readonly id: string;
|
|
33774
33833
|
/**
|
|
33775
33834
|
* A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
33776
|
-
* @type {Array<
|
|
33835
|
+
* @type {Array<object>}
|
|
33777
33836
|
* @memberof AccountsBetaApiUpdateAccount
|
|
33778
33837
|
*/
|
|
33779
|
-
readonly
|
|
33838
|
+
readonly requestBody: Array<object>;
|
|
33780
33839
|
}
|
|
33781
33840
|
/**
|
|
33782
33841
|
* AccountsBetaApi - object-oriented interface
|
|
@@ -33894,7 +33953,7 @@ export declare class AccountsBetaApi extends BaseAPI {
|
|
|
33894
33953
|
*/
|
|
33895
33954
|
listAccounts(requestParameters?: AccountsBetaApiListAccountsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountBeta[], any>>;
|
|
33896
33955
|
/**
|
|
33897
|
-
* Use this API to update an account with a PUT request.
|
|
33956
|
+
* 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.**
|
|
33898
33957
|
* @summary Update Account
|
|
33899
33958
|
* @param {AccountsBetaApiPutAccountRequest} requestParameters Request parameters.
|
|
33900
33959
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33921,7 +33980,7 @@ export declare class AccountsBetaApi extends BaseAPI {
|
|
|
33921
33980
|
*/
|
|
33922
33981
|
unlockAccount(requestParameters: AccountsBetaApiUnlockAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountsAsyncResultBeta, any>>;
|
|
33923
33982
|
/**
|
|
33924
|
-
*
|
|
33983
|
+
* 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.
|
|
33925
33984
|
* @summary Update Account
|
|
33926
33985
|
* @param {AccountsBetaApiUpdateAccountRequest} requestParameters Request parameters.
|
|
33927
33986
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33930,6 +33989,209 @@ export declare class AccountsBetaApi extends BaseAPI {
|
|
|
33930
33989
|
*/
|
|
33931
33990
|
updateAccount(requestParameters: AccountsBetaApiUpdateAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
33932
33991
|
}
|
|
33992
|
+
/**
|
|
33993
|
+
* ApplicationDiscoveryBetaApi - axios parameter creator
|
|
33994
|
+
* @export
|
|
33995
|
+
*/
|
|
33996
|
+
export declare const ApplicationDiscoveryBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33997
|
+
/**
|
|
33998
|
+
* 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.
|
|
33999
|
+
* @summary Retrieve discovered applications for tenant
|
|
34000
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34001
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34002
|
+
* @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*
|
|
34003
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
34004
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34005
|
+
* @throws {RequiredError}
|
|
34006
|
+
*/
|
|
34007
|
+
getDiscoveredApplications: (limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34008
|
+
/**
|
|
34009
|
+
* 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.
|
|
34010
|
+
* @summary CSV template download for discovery
|
|
34011
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34012
|
+
* @throws {RequiredError}
|
|
34013
|
+
*/
|
|
34014
|
+
getManualDiscoverApplicationsCsvTemplate: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34015
|
+
/**
|
|
34016
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
34017
|
+
* @summary List vendor connector mappings
|
|
34018
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34019
|
+
* @throws {RequiredError}
|
|
34020
|
+
*/
|
|
34021
|
+
getVendorConnectorMappings: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34022
|
+
/**
|
|
34023
|
+
* 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.
|
|
34024
|
+
* @summary CSV Upload to discover applications
|
|
34025
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
34026
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34027
|
+
* @throws {RequiredError}
|
|
34028
|
+
*/
|
|
34029
|
+
sendManualDiscoverApplicationsCsvTemplate: (file: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34030
|
+
};
|
|
34031
|
+
/**
|
|
34032
|
+
* ApplicationDiscoveryBetaApi - functional programming interface
|
|
34033
|
+
* @export
|
|
34034
|
+
*/
|
|
34035
|
+
export declare const ApplicationDiscoveryBetaApiFp: (configuration?: Configuration) => {
|
|
34036
|
+
/**
|
|
34037
|
+
* 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.
|
|
34038
|
+
* @summary Retrieve discovered applications for tenant
|
|
34039
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34040
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34041
|
+
* @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*
|
|
34042
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
34043
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34044
|
+
* @throws {RequiredError}
|
|
34045
|
+
*/
|
|
34046
|
+
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>>;
|
|
34047
|
+
/**
|
|
34048
|
+
* 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.
|
|
34049
|
+
* @summary CSV template download for discovery
|
|
34050
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34051
|
+
* @throws {RequiredError}
|
|
34052
|
+
*/
|
|
34053
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsTemplateBeta>>;
|
|
34054
|
+
/**
|
|
34055
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
34056
|
+
* @summary List vendor connector mappings
|
|
34057
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34058
|
+
* @throws {RequiredError}
|
|
34059
|
+
*/
|
|
34060
|
+
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMappingBeta>>>;
|
|
34061
|
+
/**
|
|
34062
|
+
* 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.
|
|
34063
|
+
* @summary CSV Upload to discover applications
|
|
34064
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
34065
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34066
|
+
* @throws {RequiredError}
|
|
34067
|
+
*/
|
|
34068
|
+
sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
34069
|
+
};
|
|
34070
|
+
/**
|
|
34071
|
+
* ApplicationDiscoveryBetaApi - factory interface
|
|
34072
|
+
* @export
|
|
34073
|
+
*/
|
|
34074
|
+
export declare const ApplicationDiscoveryBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34075
|
+
/**
|
|
34076
|
+
* 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.
|
|
34077
|
+
* @summary Retrieve discovered applications for tenant
|
|
34078
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34079
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34080
|
+
* @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*
|
|
34081
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
34082
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34083
|
+
* @throws {RequiredError}
|
|
34084
|
+
*/
|
|
34085
|
+
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>;
|
|
34086
|
+
/**
|
|
34087
|
+
* 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.
|
|
34088
|
+
* @summary CSV template download for discovery
|
|
34089
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34090
|
+
* @throws {RequiredError}
|
|
34091
|
+
*/
|
|
34092
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsTemplateBeta>;
|
|
34093
|
+
/**
|
|
34094
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
34095
|
+
* @summary List vendor connector mappings
|
|
34096
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34097
|
+
* @throws {RequiredError}
|
|
34098
|
+
*/
|
|
34099
|
+
getVendorConnectorMappings(axiosOptions?: any): AxiosPromise<Array<VendorConnectorMappingBeta>>;
|
|
34100
|
+
/**
|
|
34101
|
+
* 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.
|
|
34102
|
+
* @summary CSV Upload to discover applications
|
|
34103
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
34104
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34105
|
+
* @throws {RequiredError}
|
|
34106
|
+
*/
|
|
34107
|
+
sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: any): AxiosPromise<void>;
|
|
34108
|
+
};
|
|
34109
|
+
/**
|
|
34110
|
+
* Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryBetaApi.
|
|
34111
|
+
* @export
|
|
34112
|
+
* @interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest
|
|
34113
|
+
*/
|
|
34114
|
+
export interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest {
|
|
34115
|
+
/**
|
|
34116
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34117
|
+
* @type {number}
|
|
34118
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
34119
|
+
*/
|
|
34120
|
+
readonly limit?: number;
|
|
34121
|
+
/**
|
|
34122
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34123
|
+
* @type {number}
|
|
34124
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
34125
|
+
*/
|
|
34126
|
+
readonly offset?: number;
|
|
34127
|
+
/**
|
|
34128
|
+
* Filter results using the standard syntax described in [V3 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*
|
|
34129
|
+
* @type {string}
|
|
34130
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
34131
|
+
*/
|
|
34132
|
+
readonly filter?: string;
|
|
34133
|
+
/**
|
|
34134
|
+
* Sort results using the standard syntax described in [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**
|
|
34135
|
+
* @type {string}
|
|
34136
|
+
* @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications
|
|
34137
|
+
*/
|
|
34138
|
+
readonly sorters?: string;
|
|
34139
|
+
}
|
|
34140
|
+
/**
|
|
34141
|
+
* Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryBetaApi.
|
|
34142
|
+
* @export
|
|
34143
|
+
* @interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest
|
|
34144
|
+
*/
|
|
34145
|
+
export interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest {
|
|
34146
|
+
/**
|
|
34147
|
+
* The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
34148
|
+
* @type {any}
|
|
34149
|
+
* @memberof ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplate
|
|
34150
|
+
*/
|
|
34151
|
+
readonly file: any;
|
|
34152
|
+
}
|
|
34153
|
+
/**
|
|
34154
|
+
* ApplicationDiscoveryBetaApi - object-oriented interface
|
|
34155
|
+
* @export
|
|
34156
|
+
* @class ApplicationDiscoveryBetaApi
|
|
34157
|
+
* @extends {BaseAPI}
|
|
34158
|
+
*/
|
|
34159
|
+
export declare class ApplicationDiscoveryBetaApi extends BaseAPI {
|
|
34160
|
+
/**
|
|
34161
|
+
* 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.
|
|
34162
|
+
* @summary Retrieve discovered applications for tenant
|
|
34163
|
+
* @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters.
|
|
34164
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34165
|
+
* @throws {RequiredError}
|
|
34166
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
34167
|
+
*/
|
|
34168
|
+
getDiscoveredApplications(requestParameters?: ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DiscoveredApplicationsInnerBeta[][], any>>;
|
|
34169
|
+
/**
|
|
34170
|
+
* 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.
|
|
34171
|
+
* @summary CSV template download for discovery
|
|
34172
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34173
|
+
* @throws {RequiredError}
|
|
34174
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
34175
|
+
*/
|
|
34176
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualDiscoverApplicationsTemplateBeta, any>>;
|
|
34177
|
+
/**
|
|
34178
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
34179
|
+
* @summary List vendor connector mappings
|
|
34180
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34181
|
+
* @throws {RequiredError}
|
|
34182
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
34183
|
+
*/
|
|
34184
|
+
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMappingBeta[], any>>;
|
|
34185
|
+
/**
|
|
34186
|
+
* 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.
|
|
34187
|
+
* @summary CSV Upload to discover applications
|
|
34188
|
+
* @param {ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters.
|
|
34189
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
34190
|
+
* @throws {RequiredError}
|
|
34191
|
+
* @memberof ApplicationDiscoveryBetaApi
|
|
34192
|
+
*/
|
|
34193
|
+
sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
34194
|
+
}
|
|
33933
34195
|
/**
|
|
33934
34196
|
* ApprovalsBetaApi - axios parameter creator
|
|
33935
34197
|
* @export
|
|
@@ -34257,7 +34519,7 @@ export declare class AuthProfileBetaApi extends BaseAPI {
|
|
|
34257
34519
|
*/
|
|
34258
34520
|
export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34259
34521
|
/**
|
|
34260
|
-
* :::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).
|
|
34522
|
+
* :::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.
|
|
34261
34523
|
* @summary Complete a Campaign
|
|
34262
34524
|
* @param {string} id Campaign ID.
|
|
34263
34525
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -34267,7 +34529,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34267
34529
|
*/
|
|
34268
34530
|
completeCampaign: (id: string, completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34269
34531
|
/**
|
|
34270
|
-
* 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).
|
|
34532
|
+
* 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.
|
|
34271
34533
|
* @summary Create Campaign
|
|
34272
34534
|
* @param {CampaignBeta} campaignBeta
|
|
34273
34535
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34276,7 +34538,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34276
34538
|
*/
|
|
34277
34539
|
createCampaign: (campaignBeta: CampaignBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34278
34540
|
/**
|
|
34279
|
-
* 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).
|
|
34541
|
+
* 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.
|
|
34280
34542
|
* @summary Create a Campaign Template
|
|
34281
34543
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
34282
34544
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34285,7 +34547,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34285
34547
|
*/
|
|
34286
34548
|
createCampaignTemplate: (campaignTemplateBeta: CampaignTemplateBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34287
34549
|
/**
|
|
34288
|
-
* 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).
|
|
34550
|
+
* 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.
|
|
34289
34551
|
* @summary Delete a Campaign Template
|
|
34290
34552
|
* @param {string} id ID of the campaign template being deleted.
|
|
34291
34553
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34294,7 +34556,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34294
34556
|
*/
|
|
34295
34557
|
deleteCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34296
34558
|
/**
|
|
34297
|
-
* 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).
|
|
34559
|
+
* 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.
|
|
34298
34560
|
* @summary Delete Campaign Template Schedule
|
|
34299
34561
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
34300
34562
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34303,7 +34565,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34303
34565
|
*/
|
|
34304
34566
|
deleteCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34305
34567
|
/**
|
|
34306
|
-
* 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).
|
|
34568
|
+
* 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.
|
|
34307
34569
|
* @summary Delete Campaigns
|
|
34308
34570
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
34309
34571
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34312,7 +34574,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34312
34574
|
*/
|
|
34313
34575
|
deleteCampaigns: (deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34314
34576
|
/**
|
|
34315
|
-
* 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).
|
|
34577
|
+
* 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.
|
|
34316
34578
|
* @summary List Campaigns
|
|
34317
34579
|
* @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.
|
|
34318
34580
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34326,7 +34588,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34326
34588
|
*/
|
|
34327
34589
|
getActiveCampaigns: (detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34328
34590
|
/**
|
|
34329
|
-
* 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).
|
|
34591
|
+
* 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.
|
|
34330
34592
|
* @summary Get Campaign
|
|
34331
34593
|
* @param {string} id ID of the campaign to be retrieved.
|
|
34332
34594
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34335,7 +34597,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34335
34597
|
*/
|
|
34336
34598
|
getCampaign: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34337
34599
|
/**
|
|
34338
|
-
* 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).
|
|
34600
|
+
* 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.
|
|
34339
34601
|
* @summary Get Campaign Reports
|
|
34340
34602
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
34341
34603
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34344,7 +34606,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34344
34606
|
*/
|
|
34345
34607
|
getCampaignReports: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34346
34608
|
/**
|
|
34347
|
-
* 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).
|
|
34609
|
+
* 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.
|
|
34348
34610
|
* @summary Get Campaign Reports Configuration
|
|
34349
34611
|
* @param {*} [axiosOptions] Override http request option.
|
|
34350
34612
|
* @deprecated
|
|
@@ -34352,7 +34614,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34352
34614
|
*/
|
|
34353
34615
|
getCampaignReportsConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34354
34616
|
/**
|
|
34355
|
-
* 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).
|
|
34617
|
+
* 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.
|
|
34356
34618
|
* @summary Get a Campaign Template
|
|
34357
34619
|
* @param {string} id Requested campaign template\'s ID.
|
|
34358
34620
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34361,7 +34623,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34361
34623
|
*/
|
|
34362
34624
|
getCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34363
34625
|
/**
|
|
34364
|
-
* 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).
|
|
34626
|
+
* 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.
|
|
34365
34627
|
* @summary Get Campaign Template Schedule
|
|
34366
34628
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
34367
34629
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34370,7 +34632,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34370
34632
|
*/
|
|
34371
34633
|
getCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34372
34634
|
/**
|
|
34373
|
-
* 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).
|
|
34635
|
+
* 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.
|
|
34374
34636
|
* @summary List Campaign Templates
|
|
34375
34637
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34376
34638
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34383,7 +34645,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34383
34645
|
*/
|
|
34384
34646
|
getCampaignTemplates: (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34385
34647
|
/**
|
|
34386
|
-
* 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.
|
|
34648
|
+
* 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.
|
|
34387
34649
|
* @summary Reassign Certifications
|
|
34388
34650
|
* @param {string} id The certification campaign ID
|
|
34389
34651
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -34393,7 +34655,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34393
34655
|
*/
|
|
34394
34656
|
move: (id: string, adminReviewReassignBeta: AdminReviewReassignBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34395
34657
|
/**
|
|
34396
|
-
* 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).
|
|
34658
|
+
* 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.
|
|
34397
34659
|
* @summary Update a Campaign Template
|
|
34398
34660
|
* @param {string} id ID of the campaign template being modified.
|
|
34399
34661
|
* @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)
|
|
@@ -34403,7 +34665,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34403
34665
|
*/
|
|
34404
34666
|
patchCampaignTemplate: (id: string, jsonPatchOperationBeta: Array<JsonPatchOperationBeta>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34405
34667
|
/**
|
|
34406
|
-
* 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).
|
|
34668
|
+
* 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.
|
|
34407
34669
|
* @summary Set Campaign Reports Configuration
|
|
34408
34670
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
34409
34671
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34412,7 +34674,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34412
34674
|
*/
|
|
34413
34675
|
setCampaignReportsConfig: (campaignReportsConfigBeta: CampaignReportsConfigBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34414
34676
|
/**
|
|
34415
|
-
* 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).
|
|
34677
|
+
* 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.
|
|
34416
34678
|
* @summary Set Campaign Template Schedule
|
|
34417
34679
|
* @param {string} id ID of the campaign template being scheduled.
|
|
34418
34680
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -34422,7 +34684,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34422
34684
|
*/
|
|
34423
34685
|
setCampaignTemplateSchedule: (id: string, scheduleBeta?: ScheduleBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34424
34686
|
/**
|
|
34425
|
-
* 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).
|
|
34687
|
+
* 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.
|
|
34426
34688
|
* @summary Activate a Campaign
|
|
34427
34689
|
* @param {string} id Campaign ID.
|
|
34428
34690
|
* @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.
|
|
@@ -34432,7 +34694,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34432
34694
|
*/
|
|
34433
34695
|
startCampaign: (id: string, activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34434
34696
|
/**
|
|
34435
|
-
* 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).
|
|
34697
|
+
* 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.
|
|
34436
34698
|
* @summary Run Campaign Remediation Scan
|
|
34437
34699
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
34438
34700
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34441,7 +34703,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34441
34703
|
*/
|
|
34442
34704
|
startCampaignRemediationScan: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34443
34705
|
/**
|
|
34444
|
-
* 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).
|
|
34706
|
+
* 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.
|
|
34445
34707
|
* @summary Run Campaign Report
|
|
34446
34708
|
* @param {string} id ID of the campaign the report is being run for.
|
|
34447
34709
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -34451,7 +34713,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34451
34713
|
*/
|
|
34452
34714
|
startCampaignReport: (id: string, type: ReportTypeBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34453
34715
|
/**
|
|
34454
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
34716
|
+
* 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.
|
|
34455
34717
|
* @summary Generate a Campaign from Template
|
|
34456
34718
|
* @param {string} id ID of the campaign template to use for generation.
|
|
34457
34719
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34460,7 +34722,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34460
34722
|
*/
|
|
34461
34723
|
startGenerateCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34462
34724
|
/**
|
|
34463
|
-
* 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).
|
|
34725
|
+
* 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.
|
|
34464
34726
|
* @summary Update a Campaign
|
|
34465
34727
|
* @param {string} id ID of the campaign template being modified.
|
|
34466
34728
|
* @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
|
|
@@ -34476,7 +34738,7 @@ export declare const CertificationCampaignsBetaApiAxiosParamCreator: (configurat
|
|
|
34476
34738
|
*/
|
|
34477
34739
|
export declare const CertificationCampaignsBetaApiFp: (configuration?: Configuration) => {
|
|
34478
34740
|
/**
|
|
34479
|
-
* :::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).
|
|
34741
|
+
* :::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.
|
|
34480
34742
|
* @summary Complete a Campaign
|
|
34481
34743
|
* @param {string} id Campaign ID.
|
|
34482
34744
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -34486,7 +34748,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34486
34748
|
*/
|
|
34487
34749
|
completeCampaign(id: string, completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
34488
34750
|
/**
|
|
34489
|
-
* 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).
|
|
34751
|
+
* 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.
|
|
34490
34752
|
* @summary Create Campaign
|
|
34491
34753
|
* @param {CampaignBeta} campaignBeta
|
|
34492
34754
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34495,7 +34757,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34495
34757
|
*/
|
|
34496
34758
|
createCampaign(campaignBeta: CampaignBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignBeta>>;
|
|
34497
34759
|
/**
|
|
34498
|
-
* 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).
|
|
34760
|
+
* 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.
|
|
34499
34761
|
* @summary Create a Campaign Template
|
|
34500
34762
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
34501
34763
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34504,7 +34766,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34504
34766
|
*/
|
|
34505
34767
|
createCampaignTemplate(campaignTemplateBeta: CampaignTemplateBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplateBeta>>;
|
|
34506
34768
|
/**
|
|
34507
|
-
* 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).
|
|
34769
|
+
* 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.
|
|
34508
34770
|
* @summary Delete a Campaign Template
|
|
34509
34771
|
* @param {string} id ID of the campaign template being deleted.
|
|
34510
34772
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34513,7 +34775,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34513
34775
|
*/
|
|
34514
34776
|
deleteCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
34515
34777
|
/**
|
|
34516
|
-
* 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).
|
|
34778
|
+
* 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.
|
|
34517
34779
|
* @summary Delete Campaign Template Schedule
|
|
34518
34780
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
34519
34781
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34522,7 +34784,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34522
34784
|
*/
|
|
34523
34785
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
34524
34786
|
/**
|
|
34525
|
-
* 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).
|
|
34787
|
+
* 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.
|
|
34526
34788
|
* @summary Delete Campaigns
|
|
34527
34789
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
34528
34790
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34531,7 +34793,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34531
34793
|
*/
|
|
34532
34794
|
deleteCampaigns(deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
34533
34795
|
/**
|
|
34534
|
-
* 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).
|
|
34796
|
+
* 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.
|
|
34535
34797
|
* @summary List Campaigns
|
|
34536
34798
|
* @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.
|
|
34537
34799
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34545,7 +34807,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34545
34807
|
*/
|
|
34546
34808
|
getActiveCampaigns(detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetActiveCampaigns200ResponseInnerBeta>>>;
|
|
34547
34809
|
/**
|
|
34548
|
-
* 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).
|
|
34810
|
+
* 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.
|
|
34549
34811
|
* @summary Get Campaign
|
|
34550
34812
|
* @param {string} id ID of the campaign to be retrieved.
|
|
34551
34813
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34554,7 +34816,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34554
34816
|
*/
|
|
34555
34817
|
getCampaign(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SlimcampaignBeta>>;
|
|
34556
34818
|
/**
|
|
34557
|
-
* 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).
|
|
34819
|
+
* 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.
|
|
34558
34820
|
* @summary Get Campaign Reports
|
|
34559
34821
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
34560
34822
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34563,7 +34825,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34563
34825
|
*/
|
|
34564
34826
|
getCampaignReports(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignReportBeta>>>;
|
|
34565
34827
|
/**
|
|
34566
|
-
* 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).
|
|
34828
|
+
* 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.
|
|
34567
34829
|
* @summary Get Campaign Reports Configuration
|
|
34568
34830
|
* @param {*} [axiosOptions] Override http request option.
|
|
34569
34831
|
* @deprecated
|
|
@@ -34571,7 +34833,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34571
34833
|
*/
|
|
34572
34834
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfigBeta>>;
|
|
34573
34835
|
/**
|
|
34574
|
-
* 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).
|
|
34836
|
+
* 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.
|
|
34575
34837
|
* @summary Get a Campaign Template
|
|
34576
34838
|
* @param {string} id Requested campaign template\'s ID.
|
|
34577
34839
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34580,7 +34842,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34580
34842
|
*/
|
|
34581
34843
|
getCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplateBeta>>;
|
|
34582
34844
|
/**
|
|
34583
|
-
* 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).
|
|
34845
|
+
* 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.
|
|
34584
34846
|
* @summary Get Campaign Template Schedule
|
|
34585
34847
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
34586
34848
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34589,7 +34851,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34589
34851
|
*/
|
|
34590
34852
|
getCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleBeta>>;
|
|
34591
34853
|
/**
|
|
34592
|
-
* 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).
|
|
34854
|
+
* 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.
|
|
34593
34855
|
* @summary List Campaign Templates
|
|
34594
34856
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34595
34857
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34602,7 +34864,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34602
34864
|
*/
|
|
34603
34865
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignTemplateBeta>>>;
|
|
34604
34866
|
/**
|
|
34605
|
-
* 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.
|
|
34867
|
+
* 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.
|
|
34606
34868
|
* @summary Reassign Certifications
|
|
34607
34869
|
* @param {string} id The certification campaign ID
|
|
34608
34870
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -34612,7 +34874,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34612
34874
|
*/
|
|
34613
34875
|
move(id: string, adminReviewReassignBeta: AdminReviewReassignBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTaskBeta>>;
|
|
34614
34876
|
/**
|
|
34615
|
-
* 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).
|
|
34877
|
+
* 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.
|
|
34616
34878
|
* @summary Update a Campaign Template
|
|
34617
34879
|
* @param {string} id ID of the campaign template being modified.
|
|
34618
34880
|
* @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)
|
|
@@ -34622,7 +34884,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34622
34884
|
*/
|
|
34623
34885
|
patchCampaignTemplate(id: string, jsonPatchOperationBeta: Array<JsonPatchOperationBeta>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplateBeta>>;
|
|
34624
34886
|
/**
|
|
34625
|
-
* 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).
|
|
34887
|
+
* 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.
|
|
34626
34888
|
* @summary Set Campaign Reports Configuration
|
|
34627
34889
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
34628
34890
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34631,7 +34893,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34631
34893
|
*/
|
|
34632
34894
|
setCampaignReportsConfig(campaignReportsConfigBeta: CampaignReportsConfigBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfigBeta>>;
|
|
34633
34895
|
/**
|
|
34634
|
-
* 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).
|
|
34896
|
+
* 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.
|
|
34635
34897
|
* @summary Set Campaign Template Schedule
|
|
34636
34898
|
* @param {string} id ID of the campaign template being scheduled.
|
|
34637
34899
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -34641,7 +34903,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34641
34903
|
*/
|
|
34642
34904
|
setCampaignTemplateSchedule(id: string, scheduleBeta?: ScheduleBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
34643
34905
|
/**
|
|
34644
|
-
* 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).
|
|
34906
|
+
* 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.
|
|
34645
34907
|
* @summary Activate a Campaign
|
|
34646
34908
|
* @param {string} id Campaign ID.
|
|
34647
34909
|
* @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.
|
|
@@ -34651,7 +34913,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34651
34913
|
*/
|
|
34652
34914
|
startCampaign(id: string, activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
34653
34915
|
/**
|
|
34654
|
-
* 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).
|
|
34916
|
+
* 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.
|
|
34655
34917
|
* @summary Run Campaign Remediation Scan
|
|
34656
34918
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
34657
34919
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34660,7 +34922,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34660
34922
|
*/
|
|
34661
34923
|
startCampaignRemediationScan(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
34662
34924
|
/**
|
|
34663
|
-
* 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).
|
|
34925
|
+
* 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.
|
|
34664
34926
|
* @summary Run Campaign Report
|
|
34665
34927
|
* @param {string} id ID of the campaign the report is being run for.
|
|
34666
34928
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -34670,7 +34932,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34670
34932
|
*/
|
|
34671
34933
|
startCampaignReport(id: string, type: ReportTypeBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
34672
34934
|
/**
|
|
34673
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
34935
|
+
* 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.
|
|
34674
34936
|
* @summary Generate a Campaign from Template
|
|
34675
34937
|
* @param {string} id ID of the campaign template to use for generation.
|
|
34676
34938
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34679,7 +34941,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34679
34941
|
*/
|
|
34680
34942
|
startGenerateCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReferenceBeta>>;
|
|
34681
34943
|
/**
|
|
34682
|
-
* 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).
|
|
34944
|
+
* 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.
|
|
34683
34945
|
* @summary Update a Campaign
|
|
34684
34946
|
* @param {string} id ID of the campaign template being modified.
|
|
34685
34947
|
* @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
|
|
@@ -34695,7 +34957,7 @@ export declare const CertificationCampaignsBetaApiFp: (configuration?: Configura
|
|
|
34695
34957
|
*/
|
|
34696
34958
|
export declare const CertificationCampaignsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34697
34959
|
/**
|
|
34698
|
-
* :::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).
|
|
34960
|
+
* :::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.
|
|
34699
34961
|
* @summary Complete a Campaign
|
|
34700
34962
|
* @param {string} id Campaign ID.
|
|
34701
34963
|
* @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -34705,7 +34967,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34705
34967
|
*/
|
|
34706
34968
|
completeCampaign(id: string, completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta, axiosOptions?: any): AxiosPromise<object>;
|
|
34707
34969
|
/**
|
|
34708
|
-
* 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).
|
|
34970
|
+
* 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.
|
|
34709
34971
|
* @summary Create Campaign
|
|
34710
34972
|
* @param {CampaignBeta} campaignBeta
|
|
34711
34973
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34714,7 +34976,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34714
34976
|
*/
|
|
34715
34977
|
createCampaign(campaignBeta: CampaignBeta, axiosOptions?: any): AxiosPromise<CampaignBeta>;
|
|
34716
34978
|
/**
|
|
34717
|
-
* 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).
|
|
34979
|
+
* 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.
|
|
34718
34980
|
* @summary Create a Campaign Template
|
|
34719
34981
|
* @param {CampaignTemplateBeta} campaignTemplateBeta
|
|
34720
34982
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34723,7 +34985,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34723
34985
|
*/
|
|
34724
34986
|
createCampaignTemplate(campaignTemplateBeta: CampaignTemplateBeta, axiosOptions?: any): AxiosPromise<CampaignTemplateBeta>;
|
|
34725
34987
|
/**
|
|
34726
|
-
* 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).
|
|
34988
|
+
* 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.
|
|
34727
34989
|
* @summary Delete a Campaign Template
|
|
34728
34990
|
* @param {string} id ID of the campaign template being deleted.
|
|
34729
34991
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34732,7 +34994,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34732
34994
|
*/
|
|
34733
34995
|
deleteCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
34734
34996
|
/**
|
|
34735
|
-
* 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).
|
|
34997
|
+
* 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.
|
|
34736
34998
|
* @summary Delete Campaign Template Schedule
|
|
34737
34999
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
34738
35000
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34741,7 +35003,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34741
35003
|
*/
|
|
34742
35004
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
34743
35005
|
/**
|
|
34744
|
-
* 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).
|
|
35006
|
+
* 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.
|
|
34745
35007
|
* @summary Delete Campaigns
|
|
34746
35008
|
* @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete.
|
|
34747
35009
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34750,7 +35012,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34750
35012
|
*/
|
|
34751
35013
|
deleteCampaigns(deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta, axiosOptions?: any): AxiosPromise<object>;
|
|
34752
35014
|
/**
|
|
34753
|
-
* 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).
|
|
35015
|
+
* 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.
|
|
34754
35016
|
* @summary List Campaigns
|
|
34755
35017
|
* @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.
|
|
34756
35018
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34764,7 +35026,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34764
35026
|
*/
|
|
34765
35027
|
getActiveCampaigns(detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<GetActiveCampaigns200ResponseInnerBeta>>;
|
|
34766
35028
|
/**
|
|
34767
|
-
* 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).
|
|
35029
|
+
* 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.
|
|
34768
35030
|
* @summary Get Campaign
|
|
34769
35031
|
* @param {string} id ID of the campaign to be retrieved.
|
|
34770
35032
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34773,7 +35035,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34773
35035
|
*/
|
|
34774
35036
|
getCampaign(id: string, axiosOptions?: any): AxiosPromise<SlimcampaignBeta>;
|
|
34775
35037
|
/**
|
|
34776
|
-
* 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).
|
|
35038
|
+
* 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.
|
|
34777
35039
|
* @summary Get Campaign Reports
|
|
34778
35040
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
34779
35041
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34782,7 +35044,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34782
35044
|
*/
|
|
34783
35045
|
getCampaignReports(id: string, axiosOptions?: any): AxiosPromise<Array<CampaignReportBeta>>;
|
|
34784
35046
|
/**
|
|
34785
|
-
* 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).
|
|
35047
|
+
* 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.
|
|
34786
35048
|
* @summary Get Campaign Reports Configuration
|
|
34787
35049
|
* @param {*} [axiosOptions] Override http request option.
|
|
34788
35050
|
* @deprecated
|
|
@@ -34790,7 +35052,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34790
35052
|
*/
|
|
34791
35053
|
getCampaignReportsConfig(axiosOptions?: any): AxiosPromise<CampaignReportsConfigBeta>;
|
|
34792
35054
|
/**
|
|
34793
|
-
* 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).
|
|
35055
|
+
* 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.
|
|
34794
35056
|
* @summary Get a Campaign Template
|
|
34795
35057
|
* @param {string} id Requested campaign template\'s ID.
|
|
34796
35058
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34799,7 +35061,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34799
35061
|
*/
|
|
34800
35062
|
getCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignTemplateBeta>;
|
|
34801
35063
|
/**
|
|
34802
|
-
* 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).
|
|
35064
|
+
* 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.
|
|
34803
35065
|
* @summary Get Campaign Template Schedule
|
|
34804
35066
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
34805
35067
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34808,7 +35070,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34808
35070
|
*/
|
|
34809
35071
|
getCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<ScheduleBeta>;
|
|
34810
35072
|
/**
|
|
34811
|
-
* 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).
|
|
35073
|
+
* 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.
|
|
34812
35074
|
* @summary List Campaign Templates
|
|
34813
35075
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
34814
35076
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -34821,7 +35083,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34821
35083
|
*/
|
|
34822
35084
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<CampaignTemplateBeta>>;
|
|
34823
35085
|
/**
|
|
34824
|
-
* 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.
|
|
35086
|
+
* 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.
|
|
34825
35087
|
* @summary Reassign Certifications
|
|
34826
35088
|
* @param {string} id The certification campaign ID
|
|
34827
35089
|
* @param {AdminReviewReassignBeta} adminReviewReassignBeta
|
|
@@ -34831,7 +35093,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34831
35093
|
*/
|
|
34832
35094
|
move(id: string, adminReviewReassignBeta: AdminReviewReassignBeta, axiosOptions?: any): AxiosPromise<CertificationTaskBeta>;
|
|
34833
35095
|
/**
|
|
34834
|
-
* 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).
|
|
35096
|
+
* 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.
|
|
34835
35097
|
* @summary Update a Campaign Template
|
|
34836
35098
|
* @param {string} id ID of the campaign template being modified.
|
|
34837
35099
|
* @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)
|
|
@@ -34841,7 +35103,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34841
35103
|
*/
|
|
34842
35104
|
patchCampaignTemplate(id: string, jsonPatchOperationBeta: Array<JsonPatchOperationBeta>, axiosOptions?: any): AxiosPromise<CampaignTemplateBeta>;
|
|
34843
35105
|
/**
|
|
34844
|
-
* 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).
|
|
35106
|
+
* 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.
|
|
34845
35107
|
* @summary Set Campaign Reports Configuration
|
|
34846
35108
|
* @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration.
|
|
34847
35109
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34850,7 +35112,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34850
35112
|
*/
|
|
34851
35113
|
setCampaignReportsConfig(campaignReportsConfigBeta: CampaignReportsConfigBeta, axiosOptions?: any): AxiosPromise<CampaignReportsConfigBeta>;
|
|
34852
35114
|
/**
|
|
34853
|
-
* 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).
|
|
35115
|
+
* 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.
|
|
34854
35116
|
* @summary Set Campaign Template Schedule
|
|
34855
35117
|
* @param {string} id ID of the campaign template being scheduled.
|
|
34856
35118
|
* @param {ScheduleBeta} [scheduleBeta]
|
|
@@ -34860,7 +35122,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34860
35122
|
*/
|
|
34861
35123
|
setCampaignTemplateSchedule(id: string, scheduleBeta?: ScheduleBeta, axiosOptions?: any): AxiosPromise<void>;
|
|
34862
35124
|
/**
|
|
34863
|
-
* 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).
|
|
35125
|
+
* 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.
|
|
34864
35126
|
* @summary Activate a Campaign
|
|
34865
35127
|
* @param {string} id Campaign ID.
|
|
34866
35128
|
* @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.
|
|
@@ -34870,7 +35132,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34870
35132
|
*/
|
|
34871
35133
|
startCampaign(id: string, activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta, axiosOptions?: any): AxiosPromise<object>;
|
|
34872
35134
|
/**
|
|
34873
|
-
* 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).
|
|
35135
|
+
* 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.
|
|
34874
35136
|
* @summary Run Campaign Remediation Scan
|
|
34875
35137
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
34876
35138
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34879,7 +35141,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34879
35141
|
*/
|
|
34880
35142
|
startCampaignRemediationScan(id: string, axiosOptions?: any): AxiosPromise<object>;
|
|
34881
35143
|
/**
|
|
34882
|
-
* 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).
|
|
35144
|
+
* 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.
|
|
34883
35145
|
* @summary Run Campaign Report
|
|
34884
35146
|
* @param {string} id ID of the campaign the report is being run for.
|
|
34885
35147
|
* @param {ReportTypeBeta} type Type of report to run.
|
|
@@ -34889,7 +35151,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34889
35151
|
*/
|
|
34890
35152
|
startCampaignReport(id: string, type: ReportTypeBeta, axiosOptions?: any): AxiosPromise<object>;
|
|
34891
35153
|
/**
|
|
34892
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
35154
|
+
* 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.
|
|
34893
35155
|
* @summary Generate a Campaign from Template
|
|
34894
35156
|
* @param {string} id ID of the campaign template to use for generation.
|
|
34895
35157
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34898,7 +35160,7 @@ export declare const CertificationCampaignsBetaApiFactory: (configuration?: Conf
|
|
|
34898
35160
|
*/
|
|
34899
35161
|
startGenerateCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignReferenceBeta>;
|
|
34900
35162
|
/**
|
|
34901
|
-
* 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).
|
|
35163
|
+
* 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.
|
|
34902
35164
|
* @summary Update a Campaign
|
|
34903
35165
|
* @param {string} id ID of the campaign template being modified.
|
|
34904
35166
|
* @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
|
|
@@ -35285,7 +35547,7 @@ export interface CertificationCampaignsBetaApiUpdateCampaignRequest {
|
|
|
35285
35547
|
*/
|
|
35286
35548
|
export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
35287
35549
|
/**
|
|
35288
|
-
* :::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).
|
|
35550
|
+
* :::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.
|
|
35289
35551
|
* @summary Complete a Campaign
|
|
35290
35552
|
* @param {CertificationCampaignsBetaApiCompleteCampaignRequest} requestParameters Request parameters.
|
|
35291
35553
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35295,7 +35557,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35295
35557
|
*/
|
|
35296
35558
|
completeCampaign(requestParameters: CertificationCampaignsBetaApiCompleteCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35297
35559
|
/**
|
|
35298
|
-
* 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).
|
|
35560
|
+
* 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.
|
|
35299
35561
|
* @summary Create Campaign
|
|
35300
35562
|
* @param {CertificationCampaignsBetaApiCreateCampaignRequest} requestParameters Request parameters.
|
|
35301
35563
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35305,7 +35567,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35305
35567
|
*/
|
|
35306
35568
|
createCampaign(requestParameters: CertificationCampaignsBetaApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignBeta, any>>;
|
|
35307
35569
|
/**
|
|
35308
|
-
* 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).
|
|
35570
|
+
* 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.
|
|
35309
35571
|
* @summary Create a Campaign Template
|
|
35310
35572
|
* @param {CertificationCampaignsBetaApiCreateCampaignTemplateRequest} requestParameters Request parameters.
|
|
35311
35573
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35315,7 +35577,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35315
35577
|
*/
|
|
35316
35578
|
createCampaignTemplate(requestParameters: CertificationCampaignsBetaApiCreateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplateBeta, any>>;
|
|
35317
35579
|
/**
|
|
35318
|
-
* 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).
|
|
35580
|
+
* 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.
|
|
35319
35581
|
* @summary Delete a Campaign Template
|
|
35320
35582
|
* @param {CertificationCampaignsBetaApiDeleteCampaignTemplateRequest} requestParameters Request parameters.
|
|
35321
35583
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35325,7 +35587,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35325
35587
|
*/
|
|
35326
35588
|
deleteCampaignTemplate(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
35327
35589
|
/**
|
|
35328
|
-
* 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).
|
|
35590
|
+
* 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.
|
|
35329
35591
|
* @summary Delete Campaign Template Schedule
|
|
35330
35592
|
* @param {CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
35331
35593
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35335,7 +35597,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35335
35597
|
*/
|
|
35336
35598
|
deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
35337
35599
|
/**
|
|
35338
|
-
* 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).
|
|
35600
|
+
* 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.
|
|
35339
35601
|
* @summary Delete Campaigns
|
|
35340
35602
|
* @param {CertificationCampaignsBetaApiDeleteCampaignsRequest} requestParameters Request parameters.
|
|
35341
35603
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35345,7 +35607,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35345
35607
|
*/
|
|
35346
35608
|
deleteCampaigns(requestParameters: CertificationCampaignsBetaApiDeleteCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35347
35609
|
/**
|
|
35348
|
-
* 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).
|
|
35610
|
+
* 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.
|
|
35349
35611
|
* @summary List Campaigns
|
|
35350
35612
|
* @param {CertificationCampaignsBetaApiGetActiveCampaignsRequest} requestParameters Request parameters.
|
|
35351
35613
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35355,7 +35617,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35355
35617
|
*/
|
|
35356
35618
|
getActiveCampaigns(requestParameters?: CertificationCampaignsBetaApiGetActiveCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInnerBeta[], any>>;
|
|
35357
35619
|
/**
|
|
35358
|
-
* 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).
|
|
35620
|
+
* 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.
|
|
35359
35621
|
* @summary Get Campaign
|
|
35360
35622
|
* @param {CertificationCampaignsBetaApiGetCampaignRequest} requestParameters Request parameters.
|
|
35361
35623
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35365,7 +35627,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35365
35627
|
*/
|
|
35366
35628
|
getCampaign(requestParameters: CertificationCampaignsBetaApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SlimcampaignBeta, any>>;
|
|
35367
35629
|
/**
|
|
35368
|
-
* 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).
|
|
35630
|
+
* 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.
|
|
35369
35631
|
* @summary Get Campaign Reports
|
|
35370
35632
|
* @param {CertificationCampaignsBetaApiGetCampaignReportsRequest} requestParameters Request parameters.
|
|
35371
35633
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35375,7 +35637,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35375
35637
|
*/
|
|
35376
35638
|
getCampaignReports(requestParameters: CertificationCampaignsBetaApiGetCampaignReportsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportBeta[], any>>;
|
|
35377
35639
|
/**
|
|
35378
|
-
* 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).
|
|
35640
|
+
* 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.
|
|
35379
35641
|
* @summary Get Campaign Reports Configuration
|
|
35380
35642
|
* @param {*} [axiosOptions] Override http request option.
|
|
35381
35643
|
* @deprecated
|
|
@@ -35384,7 +35646,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35384
35646
|
*/
|
|
35385
35647
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfigBeta, any>>;
|
|
35386
35648
|
/**
|
|
35387
|
-
* 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).
|
|
35649
|
+
* 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.
|
|
35388
35650
|
* @summary Get a Campaign Template
|
|
35389
35651
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplateRequest} requestParameters Request parameters.
|
|
35390
35652
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35394,7 +35656,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35394
35656
|
*/
|
|
35395
35657
|
getCampaignTemplate(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplateBeta, any>>;
|
|
35396
35658
|
/**
|
|
35397
|
-
* 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).
|
|
35659
|
+
* 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.
|
|
35398
35660
|
* @summary Get Campaign Template Schedule
|
|
35399
35661
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
35400
35662
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35404,7 +35666,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35404
35666
|
*/
|
|
35405
35667
|
getCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleBeta, any>>;
|
|
35406
35668
|
/**
|
|
35407
|
-
* 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).
|
|
35669
|
+
* 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.
|
|
35408
35670
|
* @summary List Campaign Templates
|
|
35409
35671
|
* @param {CertificationCampaignsBetaApiGetCampaignTemplatesRequest} requestParameters Request parameters.
|
|
35410
35672
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35414,7 +35676,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35414
35676
|
*/
|
|
35415
35677
|
getCampaignTemplates(requestParameters?: CertificationCampaignsBetaApiGetCampaignTemplatesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplateBeta[], any>>;
|
|
35416
35678
|
/**
|
|
35417
|
-
* 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.
|
|
35679
|
+
* 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.
|
|
35418
35680
|
* @summary Reassign Certifications
|
|
35419
35681
|
* @param {CertificationCampaignsBetaApiMoveRequest} requestParameters Request parameters.
|
|
35420
35682
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35424,7 +35686,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35424
35686
|
*/
|
|
35425
35687
|
move(requestParameters: CertificationCampaignsBetaApiMoveRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTaskBeta, any>>;
|
|
35426
35688
|
/**
|
|
35427
|
-
* 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).
|
|
35689
|
+
* 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.
|
|
35428
35690
|
* @summary Update a Campaign Template
|
|
35429
35691
|
* @param {CertificationCampaignsBetaApiPatchCampaignTemplateRequest} requestParameters Request parameters.
|
|
35430
35692
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35434,7 +35696,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35434
35696
|
*/
|
|
35435
35697
|
patchCampaignTemplate(requestParameters: CertificationCampaignsBetaApiPatchCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplateBeta, any>>;
|
|
35436
35698
|
/**
|
|
35437
|
-
* 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).
|
|
35699
|
+
* 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.
|
|
35438
35700
|
* @summary Set Campaign Reports Configuration
|
|
35439
35701
|
* @param {CertificationCampaignsBetaApiSetCampaignReportsConfigRequest} requestParameters Request parameters.
|
|
35440
35702
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35444,7 +35706,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35444
35706
|
*/
|
|
35445
35707
|
setCampaignReportsConfig(requestParameters: CertificationCampaignsBetaApiSetCampaignReportsConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfigBeta, any>>;
|
|
35446
35708
|
/**
|
|
35447
|
-
* 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).
|
|
35709
|
+
* 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.
|
|
35448
35710
|
* @summary Set Campaign Template Schedule
|
|
35449
35711
|
* @param {CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
35450
35712
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35454,7 +35716,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35454
35716
|
*/
|
|
35455
35717
|
setCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
35456
35718
|
/**
|
|
35457
|
-
* 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).
|
|
35719
|
+
* 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.
|
|
35458
35720
|
* @summary Activate a Campaign
|
|
35459
35721
|
* @param {CertificationCampaignsBetaApiStartCampaignRequest} requestParameters Request parameters.
|
|
35460
35722
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35464,7 +35726,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35464
35726
|
*/
|
|
35465
35727
|
startCampaign(requestParameters: CertificationCampaignsBetaApiStartCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35466
35728
|
/**
|
|
35467
|
-
* 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).
|
|
35729
|
+
* 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.
|
|
35468
35730
|
* @summary Run Campaign Remediation Scan
|
|
35469
35731
|
* @param {CertificationCampaignsBetaApiStartCampaignRemediationScanRequest} requestParameters Request parameters.
|
|
35470
35732
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35474,7 +35736,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35474
35736
|
*/
|
|
35475
35737
|
startCampaignRemediationScan(requestParameters: CertificationCampaignsBetaApiStartCampaignRemediationScanRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35476
35738
|
/**
|
|
35477
|
-
* 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).
|
|
35739
|
+
* 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.
|
|
35478
35740
|
* @summary Run Campaign Report
|
|
35479
35741
|
* @param {CertificationCampaignsBetaApiStartCampaignReportRequest} requestParameters Request parameters.
|
|
35480
35742
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35484,7 +35746,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35484
35746
|
*/
|
|
35485
35747
|
startCampaignReport(requestParameters: CertificationCampaignsBetaApiStartCampaignReportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
35486
35748
|
/**
|
|
35487
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
35749
|
+
* 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.
|
|
35488
35750
|
* @summary Generate a Campaign from Template
|
|
35489
35751
|
* @param {CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters.
|
|
35490
35752
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35494,7 +35756,7 @@ export declare class CertificationCampaignsBetaApi extends BaseAPI {
|
|
|
35494
35756
|
*/
|
|
35495
35757
|
startGenerateCampaignTemplate(requestParameters: CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReferenceBeta, any>>;
|
|
35496
35758
|
/**
|
|
35497
|
-
* 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).
|
|
35759
|
+
* 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.
|
|
35498
35760
|
* @summary Update a Campaign
|
|
35499
35761
|
* @param {CertificationCampaignsBetaApiUpdateCampaignRequest} requestParameters Request parameters.
|
|
35500
35762
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36295,6 +36557,14 @@ export declare const CustomFormsBetaApiAxiosParamCreator: (configuration?: Confi
|
|
|
36295
36557
|
* @throws {RequiredError}
|
|
36296
36558
|
*/
|
|
36297
36559
|
createFormDefinition: (createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36560
|
+
/**
|
|
36561
|
+
*
|
|
36562
|
+
* @summary Create a form definition by template.
|
|
36563
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
36564
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
36565
|
+
* @throws {RequiredError}
|
|
36566
|
+
*/
|
|
36567
|
+
createFormDefinitionByTemplate: (createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36298
36568
|
/**
|
|
36299
36569
|
*
|
|
36300
36570
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -36466,6 +36736,14 @@ export declare const CustomFormsBetaApiFp: (configuration?: Configuration) => {
|
|
|
36466
36736
|
* @throws {RequiredError}
|
|
36467
36737
|
*/
|
|
36468
36738
|
createFormDefinition(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormDefinitionResponseBeta>>;
|
|
36739
|
+
/**
|
|
36740
|
+
*
|
|
36741
|
+
* @summary Create a form definition by template.
|
|
36742
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
36743
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
36744
|
+
* @throws {RequiredError}
|
|
36745
|
+
*/
|
|
36746
|
+
createFormDefinitionByTemplate(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormDefinitionResponseBeta>>;
|
|
36469
36747
|
/**
|
|
36470
36748
|
*
|
|
36471
36749
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -36637,6 +36915,14 @@ export declare const CustomFormsBetaApiFactory: (configuration?: Configuration,
|
|
|
36637
36915
|
* @throws {RequiredError}
|
|
36638
36916
|
*/
|
|
36639
36917
|
createFormDefinition(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: any): AxiosPromise<FormDefinitionResponseBeta>;
|
|
36918
|
+
/**
|
|
36919
|
+
*
|
|
36920
|
+
* @summary Create a form definition by template.
|
|
36921
|
+
* @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request
|
|
36922
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
36923
|
+
* @throws {RequiredError}
|
|
36924
|
+
*/
|
|
36925
|
+
createFormDefinitionByTemplate(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: any): AxiosPromise<FormDefinitionResponseBeta>;
|
|
36640
36926
|
/**
|
|
36641
36927
|
*
|
|
36642
36928
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -36808,6 +37094,19 @@ export interface CustomFormsBetaApiCreateFormDefinitionRequest {
|
|
|
36808
37094
|
*/
|
|
36809
37095
|
readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta;
|
|
36810
37096
|
}
|
|
37097
|
+
/**
|
|
37098
|
+
* Request parameters for createFormDefinitionByTemplate operation in CustomFormsBetaApi.
|
|
37099
|
+
* @export
|
|
37100
|
+
* @interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest
|
|
37101
|
+
*/
|
|
37102
|
+
export interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest {
|
|
37103
|
+
/**
|
|
37104
|
+
* Body is the request payload to create form definition request
|
|
37105
|
+
* @type {CreateFormDefinitionRequestBeta}
|
|
37106
|
+
* @memberof CustomFormsBetaApiCreateFormDefinitionByTemplate
|
|
37107
|
+
*/
|
|
37108
|
+
readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta;
|
|
37109
|
+
}
|
|
36811
37110
|
/**
|
|
36812
37111
|
* Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsBetaApi.
|
|
36813
37112
|
* @export
|
|
@@ -37137,6 +37436,15 @@ export declare class CustomFormsBetaApi extends BaseAPI {
|
|
|
37137
37436
|
* @memberof CustomFormsBetaApi
|
|
37138
37437
|
*/
|
|
37139
37438
|
createFormDefinition(requestParameters?: CustomFormsBetaApiCreateFormDefinitionRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FormDefinitionResponseBeta, any>>;
|
|
37439
|
+
/**
|
|
37440
|
+
*
|
|
37441
|
+
* @summary Create a form definition by template.
|
|
37442
|
+
* @param {CustomFormsBetaApiCreateFormDefinitionByTemplateRequest} requestParameters Request parameters.
|
|
37443
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
37444
|
+
* @throws {RequiredError}
|
|
37445
|
+
* @memberof CustomFormsBetaApi
|
|
37446
|
+
*/
|
|
37447
|
+
createFormDefinitionByTemplate(requestParameters?: CustomFormsBetaApiCreateFormDefinitionByTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FormDefinitionResponseBeta, any>>;
|
|
37140
37448
|
/**
|
|
37141
37449
|
*
|
|
37142
37450
|
* @summary Generate JSON Schema dynamically.
|
|
@@ -37471,105 +37779,6 @@ export declare class CustomPasswordInstructionsBetaApi extends BaseAPI {
|
|
|
37471
37779
|
*/
|
|
37472
37780
|
getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomPasswordInstructionBeta, any>>;
|
|
37473
37781
|
}
|
|
37474
|
-
/**
|
|
37475
|
-
* DiscoveredApplicationsBetaApi - axios parameter creator
|
|
37476
|
-
* @export
|
|
37477
|
-
*/
|
|
37478
|
-
export declare const DiscoveredApplicationsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37479
|
-
/**
|
|
37480
|
-
* 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.
|
|
37481
|
-
* @summary Retrieve discovered applications for tenant
|
|
37482
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37483
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37484
|
-
* @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*
|
|
37485
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37486
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
37487
|
-
* @throws {RequiredError}
|
|
37488
|
-
*/
|
|
37489
|
-
getDiscoveredApplications: (limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37490
|
-
};
|
|
37491
|
-
/**
|
|
37492
|
-
* DiscoveredApplicationsBetaApi - functional programming interface
|
|
37493
|
-
* @export
|
|
37494
|
-
*/
|
|
37495
|
-
export declare const DiscoveredApplicationsBetaApiFp: (configuration?: Configuration) => {
|
|
37496
|
-
/**
|
|
37497
|
-
* 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.
|
|
37498
|
-
* @summary Retrieve discovered applications for tenant
|
|
37499
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37500
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37501
|
-
* @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*
|
|
37502
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37503
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
37504
|
-
* @throws {RequiredError}
|
|
37505
|
-
*/
|
|
37506
|
-
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>>;
|
|
37507
|
-
};
|
|
37508
|
-
/**
|
|
37509
|
-
* DiscoveredApplicationsBetaApi - factory interface
|
|
37510
|
-
* @export
|
|
37511
|
-
*/
|
|
37512
|
-
export declare const DiscoveredApplicationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37513
|
-
/**
|
|
37514
|
-
* 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.
|
|
37515
|
-
* @summary Retrieve discovered applications for tenant
|
|
37516
|
-
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37517
|
-
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37518
|
-
* @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*
|
|
37519
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
37520
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
37521
|
-
* @throws {RequiredError}
|
|
37522
|
-
*/
|
|
37523
|
-
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Array<DiscoveredApplicationsInnerBeta>>>;
|
|
37524
|
-
};
|
|
37525
|
-
/**
|
|
37526
|
-
* Request parameters for getDiscoveredApplications operation in DiscoveredApplicationsBetaApi.
|
|
37527
|
-
* @export
|
|
37528
|
-
* @interface DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest
|
|
37529
|
-
*/
|
|
37530
|
-
export interface DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest {
|
|
37531
|
-
/**
|
|
37532
|
-
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37533
|
-
* @type {number}
|
|
37534
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
37535
|
-
*/
|
|
37536
|
-
readonly limit?: number;
|
|
37537
|
-
/**
|
|
37538
|
-
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
37539
|
-
* @type {number}
|
|
37540
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
37541
|
-
*/
|
|
37542
|
-
readonly offset?: number;
|
|
37543
|
-
/**
|
|
37544
|
-
* Filter results using the standard syntax described in [V3 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*
|
|
37545
|
-
* @type {string}
|
|
37546
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
37547
|
-
*/
|
|
37548
|
-
readonly filter?: string;
|
|
37549
|
-
/**
|
|
37550
|
-
* Sort results using the standard syntax described in [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**
|
|
37551
|
-
* @type {string}
|
|
37552
|
-
* @memberof DiscoveredApplicationsBetaApiGetDiscoveredApplications
|
|
37553
|
-
*/
|
|
37554
|
-
readonly sorters?: string;
|
|
37555
|
-
}
|
|
37556
|
-
/**
|
|
37557
|
-
* DiscoveredApplicationsBetaApi - object-oriented interface
|
|
37558
|
-
* @export
|
|
37559
|
-
* @class DiscoveredApplicationsBetaApi
|
|
37560
|
-
* @extends {BaseAPI}
|
|
37561
|
-
*/
|
|
37562
|
-
export declare class DiscoveredApplicationsBetaApi extends BaseAPI {
|
|
37563
|
-
/**
|
|
37564
|
-
* 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.
|
|
37565
|
-
* @summary Retrieve discovered applications for tenant
|
|
37566
|
-
* @param {DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters.
|
|
37567
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
37568
|
-
* @throws {RequiredError}
|
|
37569
|
-
* @memberof DiscoveredApplicationsBetaApi
|
|
37570
|
-
*/
|
|
37571
|
-
getDiscoveredApplications(requestParameters?: DiscoveredApplicationsBetaApiGetDiscoveredApplicationsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DiscoveredApplicationsInnerBeta[][], any>>;
|
|
37572
|
-
}
|
|
37573
37782
|
/**
|
|
37574
37783
|
* EntitlementsBetaApi - axios parameter creator
|
|
37575
37784
|
* @export
|
|
@@ -40827,7 +41036,7 @@ export declare const IAIRoleMiningBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
40827
41036
|
getIdentitiesPotentialRole: (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40828
41037
|
/**
|
|
40829
41038
|
* This method returns a specific potential role for a role mining session.
|
|
40830
|
-
* @summary
|
|
41039
|
+
* @summary Retrieve potential role in session
|
|
40831
41040
|
* @param {string} sessionId The role mining session id
|
|
40832
41041
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
40833
41042
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -40861,7 +41070,7 @@ export declare const IAIRoleMiningBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
40861
41070
|
getPotentialRoleSourceIdentityUsage: (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40862
41071
|
/**
|
|
40863
41072
|
* This method returns the potential role summaries for a role mining session.
|
|
40864
|
-
* @summary
|
|
41073
|
+
* @summary Retrieve session\'s potential role summaries
|
|
40865
41074
|
* @param {string} sessionId The role mining session id
|
|
40866
41075
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
40867
41076
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -40920,8 +41129,8 @@ export declare const IAIRoleMiningBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
40920
41129
|
*/
|
|
40921
41130
|
getSavedPotentialRoles: (sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40922
41131
|
/**
|
|
40923
|
-
*
|
|
40924
|
-
* @summary Update a potential role
|
|
41132
|
+
* 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.**
|
|
41133
|
+
* @summary Update a potential role in session
|
|
40925
41134
|
* @param {string} sessionId The role mining session id
|
|
40926
41135
|
* @param {string} potentialRoleId The potential role summary id
|
|
40927
41136
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -40930,15 +41139,14 @@ export declare const IAIRoleMiningBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
40930
41139
|
*/
|
|
40931
41140
|
patchPotentialRole: (sessionId: string, potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40932
41141
|
/**
|
|
40933
|
-
*
|
|
41142
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
40934
41143
|
* @summary Update a potential role
|
|
40935
|
-
* @param {string} sessionId The role mining session id
|
|
40936
41144
|
* @param {string} potentialRoleId The potential role summary id
|
|
40937
41145
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
40938
41146
|
* @param {*} [axiosOptions] Override http request option.
|
|
40939
41147
|
* @throws {RequiredError}
|
|
40940
41148
|
*/
|
|
40941
|
-
|
|
41149
|
+
patchRoleMiningPotentialRole: (potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40942
41150
|
/**
|
|
40943
41151
|
* 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.
|
|
40944
41152
|
* @summary Patch a role mining session
|
|
@@ -41092,7 +41300,7 @@ export declare const IAIRoleMiningBetaApiFp: (configuration?: Configuration) =>
|
|
|
41092
41300
|
getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleMiningIdentityBeta>>>;
|
|
41093
41301
|
/**
|
|
41094
41302
|
* This method returns a specific potential role for a role mining session.
|
|
41095
|
-
* @summary
|
|
41303
|
+
* @summary Retrieve potential role in session
|
|
41096
41304
|
* @param {string} sessionId The role mining session id
|
|
41097
41305
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
41098
41306
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41126,7 +41334,7 @@ export declare const IAIRoleMiningBetaApiFp: (configuration?: Configuration) =>
|
|
|
41126
41334
|
getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleMiningPotentialRoleSourceUsageBeta>>>;
|
|
41127
41335
|
/**
|
|
41128
41336
|
* This method returns the potential role summaries for a role mining session.
|
|
41129
|
-
* @summary
|
|
41337
|
+
* @summary Retrieve session\'s potential role summaries
|
|
41130
41338
|
* @param {string} sessionId The role mining session id
|
|
41131
41339
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
41132
41340
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -41185,8 +41393,8 @@ export declare const IAIRoleMiningBetaApiFp: (configuration?: Configuration) =>
|
|
|
41185
41393
|
*/
|
|
41186
41394
|
getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleMiningSessionDraftRoleDtoBeta>>>;
|
|
41187
41395
|
/**
|
|
41188
|
-
*
|
|
41189
|
-
* @summary Update a potential role
|
|
41396
|
+
* 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.**
|
|
41397
|
+
* @summary Update a potential role in session
|
|
41190
41398
|
* @param {string} sessionId The role mining session id
|
|
41191
41399
|
* @param {string} potentialRoleId The potential role summary id
|
|
41192
41400
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -41195,15 +41403,14 @@ export declare const IAIRoleMiningBetaApiFp: (configuration?: Configuration) =>
|
|
|
41195
41403
|
*/
|
|
41196
41404
|
patchPotentialRole(sessionId: string, potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
41197
41405
|
/**
|
|
41198
|
-
*
|
|
41406
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
41199
41407
|
* @summary Update a potential role
|
|
41200
|
-
* @param {string} sessionId The role mining session id
|
|
41201
41408
|
* @param {string} potentialRoleId The potential role summary id
|
|
41202
41409
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
41203
41410
|
* @param {*} [axiosOptions] Override http request option.
|
|
41204
41411
|
* @throws {RequiredError}
|
|
41205
41412
|
*/
|
|
41206
|
-
|
|
41413
|
+
patchRoleMiningPotentialRole(potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
41207
41414
|
/**
|
|
41208
41415
|
* 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.
|
|
41209
41416
|
* @summary Patch a role mining session
|
|
@@ -41357,7 +41564,7 @@ export declare const IAIRoleMiningBetaApiFactory: (configuration?: Configuration
|
|
|
41357
41564
|
getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<RoleMiningIdentityBeta>>;
|
|
41358
41565
|
/**
|
|
41359
41566
|
* This method returns a specific potential role for a role mining session.
|
|
41360
|
-
* @summary
|
|
41567
|
+
* @summary Retrieve potential role in session
|
|
41361
41568
|
* @param {string} sessionId The role mining session id
|
|
41362
41569
|
* @param {string} potentialRoleId A potential role id in a role mining session
|
|
41363
41570
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -41391,7 +41598,7 @@ export declare const IAIRoleMiningBetaApiFactory: (configuration?: Configuration
|
|
|
41391
41598
|
getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<RoleMiningPotentialRoleSourceUsageBeta>>;
|
|
41392
41599
|
/**
|
|
41393
41600
|
* This method returns the potential role summaries for a role mining session.
|
|
41394
|
-
* @summary
|
|
41601
|
+
* @summary Retrieve session\'s potential role summaries
|
|
41395
41602
|
* @param {string} sessionId The role mining session id
|
|
41396
41603
|
* @param {string} [sorters] Sort results using the standard syntax described 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**
|
|
41397
41604
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
@@ -41450,8 +41657,8 @@ export declare const IAIRoleMiningBetaApiFactory: (configuration?: Configuration
|
|
|
41450
41657
|
*/
|
|
41451
41658
|
getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<RoleMiningSessionDraftRoleDtoBeta>>;
|
|
41452
41659
|
/**
|
|
41453
|
-
*
|
|
41454
|
-
* @summary Update a potential role
|
|
41660
|
+
* 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.**
|
|
41661
|
+
* @summary Update a potential role in session
|
|
41455
41662
|
* @param {string} sessionId The role mining session id
|
|
41456
41663
|
* @param {string} potentialRoleId The potential role summary id
|
|
41457
41664
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
@@ -41460,15 +41667,14 @@ export declare const IAIRoleMiningBetaApiFactory: (configuration?: Configuration
|
|
|
41460
41667
|
*/
|
|
41461
41668
|
patchPotentialRole(sessionId: string, potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: any): AxiosPromise<object>;
|
|
41462
41669
|
/**
|
|
41463
|
-
*
|
|
41670
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
41464
41671
|
* @summary Update a potential role
|
|
41465
|
-
* @param {string} sessionId The role mining session id
|
|
41466
41672
|
* @param {string} potentialRoleId The potential role summary id
|
|
41467
41673
|
* @param {Array<PatchPotentialRoleRequestInnerBeta>} patchPotentialRoleRequestInnerBeta
|
|
41468
41674
|
* @param {*} [axiosOptions] Override http request option.
|
|
41469
41675
|
* @throws {RequiredError}
|
|
41470
41676
|
*/
|
|
41471
|
-
|
|
41677
|
+
patchRoleMiningPotentialRole(potentialRoleId: string, patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>, axiosOptions?: any): AxiosPromise<object>;
|
|
41472
41678
|
/**
|
|
41473
41679
|
* 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.
|
|
41474
41680
|
* @summary Patch a role mining session
|
|
@@ -42123,27 +42329,21 @@ export interface IAIRoleMiningBetaApiPatchPotentialRoleRequest {
|
|
|
42123
42329
|
readonly patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>;
|
|
42124
42330
|
}
|
|
42125
42331
|
/**
|
|
42126
|
-
* Request parameters for
|
|
42332
|
+
* Request parameters for patchRoleMiningPotentialRole operation in IAIRoleMiningBetaApi.
|
|
42127
42333
|
* @export
|
|
42128
|
-
* @interface
|
|
42334
|
+
* @interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest
|
|
42129
42335
|
*/
|
|
42130
|
-
export interface
|
|
42131
|
-
/**
|
|
42132
|
-
* The role mining session id
|
|
42133
|
-
* @type {string}
|
|
42134
|
-
* @memberof IAIRoleMiningBetaApiPatchPotentialRole0
|
|
42135
|
-
*/
|
|
42136
|
-
readonly sessionId: string;
|
|
42336
|
+
export interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest {
|
|
42137
42337
|
/**
|
|
42138
42338
|
* The potential role summary id
|
|
42139
42339
|
* @type {string}
|
|
42140
|
-
* @memberof
|
|
42340
|
+
* @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole
|
|
42141
42341
|
*/
|
|
42142
42342
|
readonly potentialRoleId: string;
|
|
42143
42343
|
/**
|
|
42144
42344
|
*
|
|
42145
42345
|
* @type {Array<PatchPotentialRoleRequestInnerBeta>}
|
|
42146
|
-
* @memberof
|
|
42346
|
+
* @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole
|
|
42147
42347
|
*/
|
|
42148
42348
|
readonly patchPotentialRoleRequestInnerBeta: Array<PatchPotentialRoleRequestInnerBeta>;
|
|
42149
42349
|
}
|
|
@@ -42301,7 +42501,7 @@ export declare class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
42301
42501
|
getIdentitiesPotentialRole(requestParameters: IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleMiningIdentityBeta[], any>>;
|
|
42302
42502
|
/**
|
|
42303
42503
|
* This method returns a specific potential role for a role mining session.
|
|
42304
|
-
* @summary
|
|
42504
|
+
* @summary Retrieve potential role in session
|
|
42305
42505
|
* @param {IAIRoleMiningBetaApiGetPotentialRoleRequest} requestParameters Request parameters.
|
|
42306
42506
|
* @param {*} [axiosOptions] Override http request option.
|
|
42307
42507
|
* @throws {RequiredError}
|
|
@@ -42328,7 +42528,7 @@ export declare class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
42328
42528
|
getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleMiningPotentialRoleSourceUsageBeta[], any>>;
|
|
42329
42529
|
/**
|
|
42330
42530
|
* This method returns the potential role summaries for a role mining session.
|
|
42331
|
-
* @summary
|
|
42531
|
+
* @summary Retrieve session\'s potential role summaries
|
|
42332
42532
|
* @param {IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest} requestParameters Request parameters.
|
|
42333
42533
|
* @param {*} [axiosOptions] Override http request option.
|
|
42334
42534
|
* @throws {RequiredError}
|
|
@@ -42381,8 +42581,8 @@ export declare class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
42381
42581
|
*/
|
|
42382
42582
|
getSavedPotentialRoles(requestParameters?: IAIRoleMiningBetaApiGetSavedPotentialRolesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleMiningSessionDraftRoleDtoBeta[], any>>;
|
|
42383
42583
|
/**
|
|
42384
|
-
*
|
|
42385
|
-
* @summary Update a potential role
|
|
42584
|
+
* 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.**
|
|
42585
|
+
* @summary Update a potential role in session
|
|
42386
42586
|
* @param {IAIRoleMiningBetaApiPatchPotentialRoleRequest} requestParameters Request parameters.
|
|
42387
42587
|
* @param {*} [axiosOptions] Override http request option.
|
|
42388
42588
|
* @throws {RequiredError}
|
|
@@ -42390,14 +42590,14 @@ export declare class IAIRoleMiningBetaApi extends BaseAPI {
|
|
|
42390
42590
|
*/
|
|
42391
42591
|
patchPotentialRole(requestParameters: IAIRoleMiningBetaApiPatchPotentialRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
42392
42592
|
/**
|
|
42393
|
-
*
|
|
42593
|
+
* This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.**
|
|
42394
42594
|
* @summary Update a potential role
|
|
42395
|
-
* @param {
|
|
42595
|
+
* @param {IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest} requestParameters Request parameters.
|
|
42396
42596
|
* @param {*} [axiosOptions] Override http request option.
|
|
42397
42597
|
* @throws {RequiredError}
|
|
42398
42598
|
* @memberof IAIRoleMiningBetaApi
|
|
42399
42599
|
*/
|
|
42400
|
-
|
|
42600
|
+
patchRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
42401
42601
|
/**
|
|
42402
42602
|
* 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.
|
|
42403
42603
|
* @summary Patch a role mining session
|
|
@@ -43172,7 +43372,7 @@ export declare class IdentitiesBetaApi extends BaseAPI {
|
|
|
43172
43372
|
*/
|
|
43173
43373
|
export declare const IdentityAttributesBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
43174
43374
|
/**
|
|
43175
|
-
* Use this API to create a new identity attribute.
|
|
43375
|
+
* Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43176
43376
|
* @summary Create Identity Attribute
|
|
43177
43377
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
43178
43378
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43180,7 +43380,7 @@ export declare const IdentityAttributesBetaApiAxiosParamCreator: (configuration?
|
|
|
43180
43380
|
*/
|
|
43181
43381
|
createIdentityAttribute: (identityAttributeBeta: IdentityAttributeBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43182
43382
|
/**
|
|
43183
|
-
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
|
|
43383
|
+
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43184
43384
|
* @summary Delete Identity Attribute
|
|
43185
43385
|
* @param {string} name The attribute\'s technical name.
|
|
43186
43386
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43188,7 +43388,7 @@ export declare const IdentityAttributesBetaApiAxiosParamCreator: (configuration?
|
|
|
43188
43388
|
*/
|
|
43189
43389
|
deleteIdentityAttribute: (name: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43190
43390
|
/**
|
|
43191
|
-
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute.
|
|
43391
|
+
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43192
43392
|
* @summary Bulk delete Identity Attributes
|
|
43193
43393
|
* @param {IdentityAttributeNamesBeta} identityAttributeNamesBeta
|
|
43194
43394
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43215,7 +43415,7 @@ export declare const IdentityAttributesBetaApiAxiosParamCreator: (configuration?
|
|
|
43215
43415
|
*/
|
|
43216
43416
|
listIdentityAttributes: (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43217
43417
|
/**
|
|
43218
|
-
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
|
|
43418
|
+
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
|
|
43219
43419
|
* @summary Update Identity Attribute
|
|
43220
43420
|
* @param {string} name The attribute\'s technical name.
|
|
43221
43421
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
@@ -43230,7 +43430,7 @@ export declare const IdentityAttributesBetaApiAxiosParamCreator: (configuration?
|
|
|
43230
43430
|
*/
|
|
43231
43431
|
export declare const IdentityAttributesBetaApiFp: (configuration?: Configuration) => {
|
|
43232
43432
|
/**
|
|
43233
|
-
* Use this API to create a new identity attribute.
|
|
43433
|
+
* Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43234
43434
|
* @summary Create Identity Attribute
|
|
43235
43435
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
43236
43436
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43238,7 +43438,7 @@ export declare const IdentityAttributesBetaApiFp: (configuration?: Configuration
|
|
|
43238
43438
|
*/
|
|
43239
43439
|
createIdentityAttribute(identityAttributeBeta: IdentityAttributeBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityAttributeBeta>>;
|
|
43240
43440
|
/**
|
|
43241
|
-
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
|
|
43441
|
+
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43242
43442
|
* @summary Delete Identity Attribute
|
|
43243
43443
|
* @param {string} name The attribute\'s technical name.
|
|
43244
43444
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43246,7 +43446,7 @@ export declare const IdentityAttributesBetaApiFp: (configuration?: Configuration
|
|
|
43246
43446
|
*/
|
|
43247
43447
|
deleteIdentityAttribute(name: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43248
43448
|
/**
|
|
43249
|
-
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute.
|
|
43449
|
+
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43250
43450
|
* @summary Bulk delete Identity Attributes
|
|
43251
43451
|
* @param {IdentityAttributeNamesBeta} identityAttributeNamesBeta
|
|
43252
43452
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43273,7 +43473,7 @@ export declare const IdentityAttributesBetaApiFp: (configuration?: Configuration
|
|
|
43273
43473
|
*/
|
|
43274
43474
|
listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityAttributeBeta>>>;
|
|
43275
43475
|
/**
|
|
43276
|
-
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
|
|
43476
|
+
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
|
|
43277
43477
|
* @summary Update Identity Attribute
|
|
43278
43478
|
* @param {string} name The attribute\'s technical name.
|
|
43279
43479
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
@@ -43288,7 +43488,7 @@ export declare const IdentityAttributesBetaApiFp: (configuration?: Configuration
|
|
|
43288
43488
|
*/
|
|
43289
43489
|
export declare const IdentityAttributesBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
43290
43490
|
/**
|
|
43291
|
-
* Use this API to create a new identity attribute.
|
|
43491
|
+
* Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43292
43492
|
* @summary Create Identity Attribute
|
|
43293
43493
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
43294
43494
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43296,7 +43496,7 @@ export declare const IdentityAttributesBetaApiFactory: (configuration?: Configur
|
|
|
43296
43496
|
*/
|
|
43297
43497
|
createIdentityAttribute(identityAttributeBeta: IdentityAttributeBeta, axiosOptions?: any): AxiosPromise<IdentityAttributeBeta>;
|
|
43298
43498
|
/**
|
|
43299
|
-
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
|
|
43499
|
+
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43300
43500
|
* @summary Delete Identity Attribute
|
|
43301
43501
|
* @param {string} name The attribute\'s technical name.
|
|
43302
43502
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43304,7 +43504,7 @@ export declare const IdentityAttributesBetaApiFactory: (configuration?: Configur
|
|
|
43304
43504
|
*/
|
|
43305
43505
|
deleteIdentityAttribute(name: string, axiosOptions?: any): AxiosPromise<void>;
|
|
43306
43506
|
/**
|
|
43307
|
-
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute.
|
|
43507
|
+
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43308
43508
|
* @summary Bulk delete Identity Attributes
|
|
43309
43509
|
* @param {IdentityAttributeNamesBeta} identityAttributeNamesBeta
|
|
43310
43510
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43331,7 +43531,7 @@ export declare const IdentityAttributesBetaApiFactory: (configuration?: Configur
|
|
|
43331
43531
|
*/
|
|
43332
43532
|
listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: any): AxiosPromise<Array<IdentityAttributeBeta>>;
|
|
43333
43533
|
/**
|
|
43334
|
-
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
|
|
43534
|
+
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
|
|
43335
43535
|
* @summary Update Identity Attribute
|
|
43336
43536
|
* @param {string} name The attribute\'s technical name.
|
|
43337
43537
|
* @param {IdentityAttributeBeta} identityAttributeBeta
|
|
@@ -43450,7 +43650,7 @@ export interface IdentityAttributesBetaApiPutIdentityAttributeRequest {
|
|
|
43450
43650
|
*/
|
|
43451
43651
|
export declare class IdentityAttributesBetaApi extends BaseAPI {
|
|
43452
43652
|
/**
|
|
43453
|
-
* Use this API to create a new identity attribute.
|
|
43653
|
+
* Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43454
43654
|
* @summary Create Identity Attribute
|
|
43455
43655
|
* @param {IdentityAttributesBetaApiCreateIdentityAttributeRequest} requestParameters Request parameters.
|
|
43456
43656
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43459,7 +43659,7 @@ export declare class IdentityAttributesBetaApi extends BaseAPI {
|
|
|
43459
43659
|
*/
|
|
43460
43660
|
createIdentityAttribute(requestParameters: IdentityAttributesBetaApiCreateIdentityAttributeRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityAttributeBeta, any>>;
|
|
43461
43661
|
/**
|
|
43462
|
-
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
|
|
43662
|
+
* This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43463
43663
|
* @summary Delete Identity Attribute
|
|
43464
43664
|
* @param {IdentityAttributesBetaApiDeleteIdentityAttributeRequest} requestParameters Request parameters.
|
|
43465
43665
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43468,7 +43668,7 @@ export declare class IdentityAttributesBetaApi extends BaseAPI {
|
|
|
43468
43668
|
*/
|
|
43469
43669
|
deleteIdentityAttribute(requestParameters: IdentityAttributesBetaApiDeleteIdentityAttributeRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
43470
43670
|
/**
|
|
43471
|
-
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute.
|
|
43671
|
+
* Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
|
|
43472
43672
|
* @summary Bulk delete Identity Attributes
|
|
43473
43673
|
* @param {IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters.
|
|
43474
43674
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43495,7 +43695,7 @@ export declare class IdentityAttributesBetaApi extends BaseAPI {
|
|
|
43495
43695
|
*/
|
|
43496
43696
|
listIdentityAttributes(requestParameters?: IdentityAttributesBetaApiListIdentityAttributesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityAttributeBeta[], any>>;
|
|
43497
43697
|
/**
|
|
43498
|
-
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
|
|
43698
|
+
* This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
|
|
43499
43699
|
* @summary Update Identity Attribute
|
|
43500
43700
|
* @param {IdentityAttributesBetaApiPutIdentityAttributeRequest} requestParameters Request parameters.
|
|
43501
43701
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -43607,17 +43807,20 @@ export declare const IdentityHistoryBetaApiAxiosParamCreator: (configuration?: C
|
|
|
43607
43807
|
* 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\'
|
|
43608
43808
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
43609
43809
|
* @param {string} id The identity id
|
|
43610
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
43810
|
+
* @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**
|
|
43811
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
43812
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
43813
|
+
* @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**
|
|
43611
43814
|
* @param {*} [axiosOptions] Override http request option.
|
|
43612
43815
|
* @throws {RequiredError}
|
|
43613
43816
|
*/
|
|
43614
|
-
listIdentityAccessItems: (id: string, type?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43817
|
+
listIdentityAccessItems: (id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43615
43818
|
/**
|
|
43616
|
-
*
|
|
43617
|
-
* @summary
|
|
43618
|
-
* @param {string} id
|
|
43619
|
-
* @param {string} date
|
|
43620
|
-
* @param {string} [type]
|
|
43819
|
+
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
43820
|
+
* @summary Get Identity Access Items Snapshot
|
|
43821
|
+
* @param {string} id Identity ID.
|
|
43822
|
+
* @param {string} date Specified date.
|
|
43823
|
+
* @param {string} [type] Access item type.
|
|
43621
43824
|
* @param {*} [axiosOptions] Override http request option.
|
|
43622
43825
|
* @throws {RequiredError}
|
|
43623
43826
|
*/
|
|
@@ -43739,17 +43942,20 @@ export declare const IdentityHistoryBetaApiFp: (configuration?: Configuration) =
|
|
|
43739
43942
|
* 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\'
|
|
43740
43943
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
43741
43944
|
* @param {string} id The identity id
|
|
43742
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
43945
|
+
* @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**
|
|
43946
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
43947
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
43948
|
+
* @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**
|
|
43743
43949
|
* @param {*} [axiosOptions] Override http request option.
|
|
43744
43950
|
* @throws {RequiredError}
|
|
43745
43951
|
*/
|
|
43746
|
-
listIdentityAccessItems(id: string, type?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>>;
|
|
43952
|
+
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>>;
|
|
43747
43953
|
/**
|
|
43748
|
-
*
|
|
43749
|
-
* @summary
|
|
43750
|
-
* @param {string} id
|
|
43751
|
-
* @param {string} date
|
|
43752
|
-
* @param {string} [type]
|
|
43954
|
+
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
43955
|
+
* @summary Get Identity Access Items Snapshot
|
|
43956
|
+
* @param {string} id Identity ID.
|
|
43957
|
+
* @param {string} date Specified date.
|
|
43958
|
+
* @param {string} [type] Access item type.
|
|
43753
43959
|
* @param {*} [axiosOptions] Override http request option.
|
|
43754
43960
|
* @throws {RequiredError}
|
|
43755
43961
|
*/
|
|
@@ -43871,17 +44077,20 @@ export declare const IdentityHistoryBetaApiFactory: (configuration?: Configurati
|
|
|
43871
44077
|
* 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\'
|
|
43872
44078
|
* @summary Gets a list of access items for the identity filtered by item type
|
|
43873
44079
|
* @param {string} id The identity id
|
|
43874
|
-
* @param {string} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
44080
|
+
* @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**
|
|
44081
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
44082
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [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**
|
|
44083
|
+
* @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**
|
|
43875
44084
|
* @param {*} [axiosOptions] Override http request option.
|
|
43876
44085
|
* @throws {RequiredError}
|
|
43877
44086
|
*/
|
|
43878
|
-
listIdentityAccessItems(id: string, type?: string, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>;
|
|
44087
|
+
listIdentityAccessItems(id: string, type?: string, filters?: string, sorters?: string, query?: string, axiosOptions?: any): AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerBeta>>;
|
|
43879
44088
|
/**
|
|
43880
|
-
*
|
|
43881
|
-
* @summary
|
|
43882
|
-
* @param {string} id
|
|
43883
|
-
* @param {string} date
|
|
43884
|
-
* @param {string} [type]
|
|
44089
|
+
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
44090
|
+
* @summary Get Identity Access Items Snapshot
|
|
44091
|
+
* @param {string} id Identity ID.
|
|
44092
|
+
* @param {string} date Specified date.
|
|
44093
|
+
* @param {string} [type] Access item type.
|
|
43885
44094
|
* @param {*} [axiosOptions] Override http request option.
|
|
43886
44095
|
* @throws {RequiredError}
|
|
43887
44096
|
*/
|
|
@@ -44197,11 +44406,29 @@ export interface IdentityHistoryBetaApiListIdentityAccessItemsRequest {
|
|
|
44197
44406
|
*/
|
|
44198
44407
|
readonly id: string;
|
|
44199
44408
|
/**
|
|
44200
|
-
* The type of access item for the identity. If not provided, it defaults to account
|
|
44409
|
+
* The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role**
|
|
44201
44410
|
* @type {string}
|
|
44202
44411
|
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
44203
44412
|
*/
|
|
44204
44413
|
readonly type?: string;
|
|
44414
|
+
/**
|
|
44415
|
+
* Filter results using the standard syntax described in [V3 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*
|
|
44416
|
+
* @type {string}
|
|
44417
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
44418
|
+
*/
|
|
44419
|
+
readonly filters?: string;
|
|
44420
|
+
/**
|
|
44421
|
+
* Sort results using the standard syntax described in [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**
|
|
44422
|
+
* @type {string}
|
|
44423
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
44424
|
+
*/
|
|
44425
|
+
readonly sorters?: string;
|
|
44426
|
+
/**
|
|
44427
|
+
* 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**
|
|
44428
|
+
* @type {string}
|
|
44429
|
+
* @memberof IdentityHistoryBetaApiListIdentityAccessItems
|
|
44430
|
+
*/
|
|
44431
|
+
readonly query?: string;
|
|
44205
44432
|
}
|
|
44206
44433
|
/**
|
|
44207
44434
|
* Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryBetaApi.
|
|
@@ -44210,19 +44437,19 @@ export interface IdentityHistoryBetaApiListIdentityAccessItemsRequest {
|
|
|
44210
44437
|
*/
|
|
44211
44438
|
export interface IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest {
|
|
44212
44439
|
/**
|
|
44213
|
-
*
|
|
44440
|
+
* Identity ID.
|
|
44214
44441
|
* @type {string}
|
|
44215
44442
|
* @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems
|
|
44216
44443
|
*/
|
|
44217
44444
|
readonly id: string;
|
|
44218
44445
|
/**
|
|
44219
|
-
*
|
|
44446
|
+
* Specified date.
|
|
44220
44447
|
* @type {string}
|
|
44221
44448
|
* @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems
|
|
44222
44449
|
*/
|
|
44223
44450
|
readonly date: string;
|
|
44224
44451
|
/**
|
|
44225
|
-
*
|
|
44452
|
+
* Access item type.
|
|
44226
44453
|
* @type {string}
|
|
44227
44454
|
* @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems
|
|
44228
44455
|
*/
|
|
@@ -44360,8 +44587,8 @@ export declare class IdentityHistoryBetaApi extends BaseAPI {
|
|
|
44360
44587
|
*/
|
|
44361
44588
|
listIdentityAccessItems(requestParameters: IdentityHistoryBetaApiListIdentityAccessItemsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIdentityAccessItems200ResponseInnerBeta[], any>>;
|
|
44362
44589
|
/**
|
|
44363
|
-
*
|
|
44364
|
-
* @summary
|
|
44590
|
+
* Use this API to get a list of identity access items at a specified date, filtered by item type.
|
|
44591
|
+
* @summary Get Identity Access Items Snapshot
|
|
44365
44592
|
* @param {IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters.
|
|
44366
44593
|
* @param {*} [axiosOptions] Override http request option.
|
|
44367
44594
|
* @throws {RequiredError}
|
|
@@ -44384,7 +44611,7 @@ export declare class IdentityHistoryBetaApi extends BaseAPI {
|
|
|
44384
44611
|
*/
|
|
44385
44612
|
export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
44386
44613
|
/**
|
|
44387
|
-
* This creates an Identity Profile
|
|
44614
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
44388
44615
|
* @summary Create an Identity Profile
|
|
44389
44616
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
44390
44617
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44419,14 +44646,6 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44419
44646
|
* @throws {RequiredError}
|
|
44420
44647
|
*/
|
|
44421
44648
|
exportIdentityProfiles: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44422
|
-
/**
|
|
44423
|
-
* 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.
|
|
44424
|
-
* @summary Generate Identity Profile Preview
|
|
44425
|
-
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44426
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
44427
|
-
* @throws {RequiredError}
|
|
44428
|
-
*/
|
|
44429
|
-
generateIdentityPreview: (identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44430
44649
|
/**
|
|
44431
44650
|
* 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.
|
|
44432
44651
|
* @summary Default identity attribute config
|
|
@@ -44436,7 +44655,7 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44436
44655
|
*/
|
|
44437
44656
|
getDefaultIdentityAttributeConfig: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44438
44657
|
/**
|
|
44439
|
-
* This returns a single Identity Profile based on ID.
|
|
44658
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
44440
44659
|
* @summary Gets a single Identity Profile
|
|
44441
44660
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44442
44661
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44453,7 +44672,7 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44453
44672
|
importIdentityProfiles: (identityProfileExportedObjectBeta: Array<IdentityProfileExportedObjectBeta>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44454
44673
|
/**
|
|
44455
44674
|
* 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.
|
|
44456
|
-
* @summary Identity Profiles
|
|
44675
|
+
* @summary Identity Profiles List
|
|
44457
44676
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44458
44677
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44459
44678
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -44463,6 +44682,14 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44463
44682
|
* @throws {RequiredError}
|
|
44464
44683
|
*/
|
|
44465
44684
|
listIdentityProfiles: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44685
|
+
/**
|
|
44686
|
+
* 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.
|
|
44687
|
+
* @summary Generate Identity Profile Preview
|
|
44688
|
+
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44689
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
44690
|
+
* @throws {RequiredError}
|
|
44691
|
+
*/
|
|
44692
|
+
showGenerateIdentityPreview: (identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44466
44693
|
/**
|
|
44467
44694
|
* 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.
|
|
44468
44695
|
* @summary Process identities under profile
|
|
@@ -44472,7 +44699,7 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44472
44699
|
*/
|
|
44473
44700
|
syncIdentityProfile: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44474
44701
|
/**
|
|
44475
|
-
* This updates the specified Identity Profile.
|
|
44702
|
+
* 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.
|
|
44476
44703
|
* @summary Update the Identity Profile
|
|
44477
44704
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44478
44705
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -44487,7 +44714,7 @@ export declare const IdentityProfilesBetaApiAxiosParamCreator: (configuration?:
|
|
|
44487
44714
|
*/
|
|
44488
44715
|
export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration) => {
|
|
44489
44716
|
/**
|
|
44490
|
-
* This creates an Identity Profile
|
|
44717
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
44491
44718
|
* @summary Create an Identity Profile
|
|
44492
44719
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
44493
44720
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44522,14 +44749,6 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44522
44749
|
* @throws {RequiredError}
|
|
44523
44750
|
*/
|
|
44524
44751
|
exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityProfileExportedObjectBeta>>>;
|
|
44525
|
-
/**
|
|
44526
|
-
* 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.
|
|
44527
|
-
* @summary Generate Identity Profile Preview
|
|
44528
|
-
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44529
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
44530
|
-
* @throws {RequiredError}
|
|
44531
|
-
*/
|
|
44532
|
-
generateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityPreviewResponseBeta>>;
|
|
44533
44752
|
/**
|
|
44534
44753
|
* 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.
|
|
44535
44754
|
* @summary Default identity attribute config
|
|
@@ -44539,7 +44758,7 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44539
44758
|
*/
|
|
44540
44759
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityAttributeConfigBeta>>;
|
|
44541
44760
|
/**
|
|
44542
|
-
* This returns a single Identity Profile based on ID.
|
|
44761
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
44543
44762
|
* @summary Gets a single Identity Profile
|
|
44544
44763
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44545
44764
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44556,7 +44775,7 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44556
44775
|
importIdentityProfiles(identityProfileExportedObjectBeta: Array<IdentityProfileExportedObjectBeta>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectImportResultBeta>>;
|
|
44557
44776
|
/**
|
|
44558
44777
|
* 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.
|
|
44559
|
-
* @summary Identity Profiles
|
|
44778
|
+
* @summary Identity Profiles List
|
|
44560
44779
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44561
44780
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44562
44781
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -44566,6 +44785,14 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44566
44785
|
* @throws {RequiredError}
|
|
44567
44786
|
*/
|
|
44568
44787
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityProfileBeta>>>;
|
|
44788
|
+
/**
|
|
44789
|
+
* 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.
|
|
44790
|
+
* @summary Generate Identity Profile Preview
|
|
44791
|
+
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44792
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
44793
|
+
* @throws {RequiredError}
|
|
44794
|
+
*/
|
|
44795
|
+
showGenerateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityPreviewResponseBeta>>;
|
|
44569
44796
|
/**
|
|
44570
44797
|
* 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.
|
|
44571
44798
|
* @summary Process identities under profile
|
|
@@ -44575,7 +44802,7 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44575
44802
|
*/
|
|
44576
44803
|
syncIdentityProfile(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
44577
44804
|
/**
|
|
44578
|
-
* This updates the specified Identity Profile.
|
|
44805
|
+
* 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.
|
|
44579
44806
|
* @summary Update the Identity Profile
|
|
44580
44807
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44581
44808
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -44590,7 +44817,7 @@ export declare const IdentityProfilesBetaApiFp: (configuration?: Configuration)
|
|
|
44590
44817
|
*/
|
|
44591
44818
|
export declare const IdentityProfilesBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
44592
44819
|
/**
|
|
44593
|
-
* This creates an Identity Profile
|
|
44820
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
44594
44821
|
* @summary Create an Identity Profile
|
|
44595
44822
|
* @param {IdentityProfileBeta} identityProfileBeta
|
|
44596
44823
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44625,14 +44852,6 @@ export declare const IdentityProfilesBetaApiFactory: (configuration?: Configurat
|
|
|
44625
44852
|
* @throws {RequiredError}
|
|
44626
44853
|
*/
|
|
44627
44854
|
exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfileExportedObjectBeta>>;
|
|
44628
|
-
/**
|
|
44629
|
-
* 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.
|
|
44630
|
-
* @summary Generate Identity Profile Preview
|
|
44631
|
-
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44632
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
44633
|
-
* @throws {RequiredError}
|
|
44634
|
-
*/
|
|
44635
|
-
generateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: any): AxiosPromise<IdentityPreviewResponseBeta>;
|
|
44636
44855
|
/**
|
|
44637
44856
|
* 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.
|
|
44638
44857
|
* @summary Default identity attribute config
|
|
@@ -44642,7 +44861,7 @@ export declare const IdentityProfilesBetaApiFactory: (configuration?: Configurat
|
|
|
44642
44861
|
*/
|
|
44643
44862
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: any): AxiosPromise<IdentityAttributeConfigBeta>;
|
|
44644
44863
|
/**
|
|
44645
|
-
* This returns a single Identity Profile based on ID.
|
|
44864
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
44646
44865
|
* @summary Gets a single Identity Profile
|
|
44647
44866
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44648
44867
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44659,7 +44878,7 @@ export declare const IdentityProfilesBetaApiFactory: (configuration?: Configurat
|
|
|
44659
44878
|
importIdentityProfiles(identityProfileExportedObjectBeta: Array<IdentityProfileExportedObjectBeta>, axiosOptions?: any): AxiosPromise<ObjectImportResultBeta>;
|
|
44660
44879
|
/**
|
|
44661
44880
|
* 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.
|
|
44662
|
-
* @summary Identity Profiles
|
|
44881
|
+
* @summary Identity Profiles List
|
|
44663
44882
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44664
44883
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44665
44884
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -44669,6 +44888,14 @@ export declare const IdentityProfilesBetaApiFactory: (configuration?: Configurat
|
|
|
44669
44888
|
* @throws {RequiredError}
|
|
44670
44889
|
*/
|
|
44671
44890
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfileBeta>>;
|
|
44891
|
+
/**
|
|
44892
|
+
* 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.
|
|
44893
|
+
* @summary Generate Identity Profile Preview
|
|
44894
|
+
* @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body.
|
|
44895
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
44896
|
+
* @throws {RequiredError}
|
|
44897
|
+
*/
|
|
44898
|
+
showGenerateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: any): AxiosPromise<IdentityPreviewResponseBeta>;
|
|
44672
44899
|
/**
|
|
44673
44900
|
* 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.
|
|
44674
44901
|
* @summary Process identities under profile
|
|
@@ -44678,7 +44905,7 @@ export declare const IdentityProfilesBetaApiFactory: (configuration?: Configurat
|
|
|
44678
44905
|
*/
|
|
44679
44906
|
syncIdentityProfile(identityProfileId: string, axiosOptions?: any): AxiosPromise<object>;
|
|
44680
44907
|
/**
|
|
44681
|
-
* This updates the specified Identity Profile.
|
|
44908
|
+
* 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.
|
|
44682
44909
|
* @summary Update the Identity Profile
|
|
44683
44910
|
* @param {string} identityProfileId The Identity Profile ID
|
|
44684
44911
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
@@ -44763,19 +44990,6 @@ export interface IdentityProfilesBetaApiExportIdentityProfilesRequest {
|
|
|
44763
44990
|
*/
|
|
44764
44991
|
readonly sorters?: string;
|
|
44765
44992
|
}
|
|
44766
|
-
/**
|
|
44767
|
-
* Request parameters for generateIdentityPreview operation in IdentityProfilesBetaApi.
|
|
44768
|
-
* @export
|
|
44769
|
-
* @interface IdentityProfilesBetaApiGenerateIdentityPreviewRequest
|
|
44770
|
-
*/
|
|
44771
|
-
export interface IdentityProfilesBetaApiGenerateIdentityPreviewRequest {
|
|
44772
|
-
/**
|
|
44773
|
-
* Identity Preview request body.
|
|
44774
|
-
* @type {IdentityPreviewRequestBeta}
|
|
44775
|
-
* @memberof IdentityProfilesBetaApiGenerateIdentityPreview
|
|
44776
|
-
*/
|
|
44777
|
-
readonly identityPreviewRequestBeta: IdentityPreviewRequestBeta;
|
|
44778
|
-
}
|
|
44779
44993
|
/**
|
|
44780
44994
|
* Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesBetaApi.
|
|
44781
44995
|
* @export
|
|
@@ -44852,6 +45066,19 @@ export interface IdentityProfilesBetaApiListIdentityProfilesRequest {
|
|
|
44852
45066
|
*/
|
|
44853
45067
|
readonly sorters?: string;
|
|
44854
45068
|
}
|
|
45069
|
+
/**
|
|
45070
|
+
* Request parameters for showGenerateIdentityPreview operation in IdentityProfilesBetaApi.
|
|
45071
|
+
* @export
|
|
45072
|
+
* @interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest
|
|
45073
|
+
*/
|
|
45074
|
+
export interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest {
|
|
45075
|
+
/**
|
|
45076
|
+
* Identity Preview request body.
|
|
45077
|
+
* @type {IdentityPreviewRequestBeta}
|
|
45078
|
+
* @memberof IdentityProfilesBetaApiShowGenerateIdentityPreview
|
|
45079
|
+
*/
|
|
45080
|
+
readonly identityPreviewRequestBeta: IdentityPreviewRequestBeta;
|
|
45081
|
+
}
|
|
44855
45082
|
/**
|
|
44856
45083
|
* Request parameters for syncIdentityProfile operation in IdentityProfilesBetaApi.
|
|
44857
45084
|
* @export
|
|
@@ -44892,7 +45119,7 @@ export interface IdentityProfilesBetaApiUpdateIdentityProfileRequest {
|
|
|
44892
45119
|
*/
|
|
44893
45120
|
export declare class IdentityProfilesBetaApi extends BaseAPI {
|
|
44894
45121
|
/**
|
|
44895
|
-
* This creates an Identity Profile
|
|
45122
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
44896
45123
|
* @summary Create an Identity Profile
|
|
44897
45124
|
* @param {IdentityProfilesBetaApiCreateIdentityProfileRequest} requestParameters Request parameters.
|
|
44898
45125
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44927,15 +45154,6 @@ export declare class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
44927
45154
|
* @memberof IdentityProfilesBetaApi
|
|
44928
45155
|
*/
|
|
44929
45156
|
exportIdentityProfiles(requestParameters?: IdentityProfilesBetaApiExportIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfileExportedObjectBeta[], any>>;
|
|
44930
|
-
/**
|
|
44931
|
-
* 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.
|
|
44932
|
-
* @summary Generate Identity Profile Preview
|
|
44933
|
-
* @param {IdentityProfilesBetaApiGenerateIdentityPreviewRequest} requestParameters Request parameters.
|
|
44934
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
44935
|
-
* @throws {RequiredError}
|
|
44936
|
-
* @memberof IdentityProfilesBetaApi
|
|
44937
|
-
*/
|
|
44938
|
-
generateIdentityPreview(requestParameters: IdentityProfilesBetaApiGenerateIdentityPreviewRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityPreviewResponseBeta, any>>;
|
|
44939
45157
|
/**
|
|
44940
45158
|
* 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.
|
|
44941
45159
|
* @summary Default identity attribute config
|
|
@@ -44946,7 +45164,7 @@ export declare class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
44946
45164
|
*/
|
|
44947
45165
|
getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityAttributeConfigBeta, any>>;
|
|
44948
45166
|
/**
|
|
44949
|
-
* This returns a single Identity Profile based on ID.
|
|
45167
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
44950
45168
|
* @summary Gets a single Identity Profile
|
|
44951
45169
|
* @param {IdentityProfilesBetaApiGetIdentityProfileRequest} requestParameters Request parameters.
|
|
44952
45170
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44965,13 +45183,22 @@ export declare class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
44965
45183
|
importIdentityProfiles(requestParameters: IdentityProfilesBetaApiImportIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectImportResultBeta, any>>;
|
|
44966
45184
|
/**
|
|
44967
45185
|
* 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.
|
|
44968
|
-
* @summary Identity Profiles
|
|
45186
|
+
* @summary Identity Profiles List
|
|
44969
45187
|
* @param {IdentityProfilesBetaApiListIdentityProfilesRequest} requestParameters Request parameters.
|
|
44970
45188
|
* @param {*} [axiosOptions] Override http request option.
|
|
44971
45189
|
* @throws {RequiredError}
|
|
44972
45190
|
* @memberof IdentityProfilesBetaApi
|
|
44973
45191
|
*/
|
|
44974
45192
|
listIdentityProfiles(requestParameters?: IdentityProfilesBetaApiListIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfileBeta[], any>>;
|
|
45193
|
+
/**
|
|
45194
|
+
* 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.
|
|
45195
|
+
* @summary Generate Identity Profile Preview
|
|
45196
|
+
* @param {IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest} requestParameters Request parameters.
|
|
45197
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
45198
|
+
* @throws {RequiredError}
|
|
45199
|
+
* @memberof IdentityProfilesBetaApi
|
|
45200
|
+
*/
|
|
45201
|
+
showGenerateIdentityPreview(requestParameters: IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityPreviewResponseBeta, any>>;
|
|
44975
45202
|
/**
|
|
44976
45203
|
* 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.
|
|
44977
45204
|
* @summary Process identities under profile
|
|
@@ -44982,7 +45209,7 @@ export declare class IdentityProfilesBetaApi extends BaseAPI {
|
|
|
44982
45209
|
*/
|
|
44983
45210
|
syncIdentityProfile(requestParameters: IdentityProfilesBetaApiSyncIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
44984
45211
|
/**
|
|
44985
|
-
* This updates the specified Identity Profile.
|
|
45212
|
+
* 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.
|
|
44986
45213
|
* @summary Update the Identity Profile
|
|
44987
45214
|
* @param {IdentityProfilesBetaApiUpdateIdentityProfileRequest} requestParameters Request parameters.
|
|
44988
45215
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -46213,133 +46440,6 @@ export declare class ManagedClustersBetaApi extends BaseAPI {
|
|
|
46213
46440
|
*/
|
|
46214
46441
|
putClientLogConfiguration(requestParameters: ManagedClustersBetaApiPutClientLogConfigurationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientLogConfigurationBeta, any>>;
|
|
46215
46442
|
}
|
|
46216
|
-
/**
|
|
46217
|
-
* ManualDiscoverApplicationsBetaApi - axios parameter creator
|
|
46218
|
-
* @export
|
|
46219
|
-
*/
|
|
46220
|
-
export declare const ManualDiscoverApplicationsBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
46221
|
-
/**
|
|
46222
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
46223
|
-
* @summary CSV Upload to discover applications
|
|
46224
|
-
* @param {any} csvFile
|
|
46225
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46226
|
-
* @throws {RequiredError}
|
|
46227
|
-
*/
|
|
46228
|
-
sendManualDiscoverApplicationsCsvTemplate: (csvFile: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46229
|
-
};
|
|
46230
|
-
/**
|
|
46231
|
-
* ManualDiscoverApplicationsBetaApi - functional programming interface
|
|
46232
|
-
* @export
|
|
46233
|
-
*/
|
|
46234
|
-
export declare const ManualDiscoverApplicationsBetaApiFp: (configuration?: Configuration) => {
|
|
46235
|
-
/**
|
|
46236
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
46237
|
-
* @summary CSV Upload to discover applications
|
|
46238
|
-
* @param {any} csvFile
|
|
46239
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46240
|
-
* @throws {RequiredError}
|
|
46241
|
-
*/
|
|
46242
|
-
sendManualDiscoverApplicationsCsvTemplate(csvFile: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsBeta>>;
|
|
46243
|
-
};
|
|
46244
|
-
/**
|
|
46245
|
-
* ManualDiscoverApplicationsBetaApi - factory interface
|
|
46246
|
-
* @export
|
|
46247
|
-
*/
|
|
46248
|
-
export declare const ManualDiscoverApplicationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
46249
|
-
/**
|
|
46250
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
46251
|
-
* @summary CSV Upload to discover applications
|
|
46252
|
-
* @param {any} csvFile
|
|
46253
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46254
|
-
* @throws {RequiredError}
|
|
46255
|
-
*/
|
|
46256
|
-
sendManualDiscoverApplicationsCsvTemplate(csvFile: any, axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsBeta>;
|
|
46257
|
-
};
|
|
46258
|
-
/**
|
|
46259
|
-
* Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ManualDiscoverApplicationsBetaApi.
|
|
46260
|
-
* @export
|
|
46261
|
-
* @interface ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest
|
|
46262
|
-
*/
|
|
46263
|
-
export interface ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest {
|
|
46264
|
-
/**
|
|
46265
|
-
*
|
|
46266
|
-
* @type {any}
|
|
46267
|
-
* @memberof ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplate
|
|
46268
|
-
*/
|
|
46269
|
-
readonly csvFile: any;
|
|
46270
|
-
}
|
|
46271
|
-
/**
|
|
46272
|
-
* ManualDiscoverApplicationsBetaApi - object-oriented interface
|
|
46273
|
-
* @export
|
|
46274
|
-
* @class ManualDiscoverApplicationsBetaApi
|
|
46275
|
-
* @extends {BaseAPI}
|
|
46276
|
-
*/
|
|
46277
|
-
export declare class ManualDiscoverApplicationsBetaApi extends BaseAPI {
|
|
46278
|
-
/**
|
|
46279
|
-
* This API allows for the upload of a CSV file containing application data to be manually correlated to potential IDN connector(s).
|
|
46280
|
-
* @summary CSV Upload to discover applications
|
|
46281
|
-
* @param {ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters.
|
|
46282
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46283
|
-
* @throws {RequiredError}
|
|
46284
|
-
* @memberof ManualDiscoverApplicationsBetaApi
|
|
46285
|
-
*/
|
|
46286
|
-
sendManualDiscoverApplicationsCsvTemplate(requestParameters: ManualDiscoverApplicationsBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualDiscoverApplicationsBeta, any>>;
|
|
46287
|
-
}
|
|
46288
|
-
/**
|
|
46289
|
-
* ManualDiscoverApplicationsTemplateBetaApi - axios parameter creator
|
|
46290
|
-
* @export
|
|
46291
|
-
*/
|
|
46292
|
-
export declare const ManualDiscoverApplicationsTemplateBetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
46293
|
-
/**
|
|
46294
|
-
* 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\'.
|
|
46295
|
-
* @summary CSV template download for discovery
|
|
46296
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46297
|
-
* @throws {RequiredError}
|
|
46298
|
-
*/
|
|
46299
|
-
getManualDiscoverApplicationsCsvTemplate: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46300
|
-
};
|
|
46301
|
-
/**
|
|
46302
|
-
* ManualDiscoverApplicationsTemplateBetaApi - functional programming interface
|
|
46303
|
-
* @export
|
|
46304
|
-
*/
|
|
46305
|
-
export declare const ManualDiscoverApplicationsTemplateBetaApiFp: (configuration?: Configuration) => {
|
|
46306
|
-
/**
|
|
46307
|
-
* 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\'.
|
|
46308
|
-
* @summary CSV template download for discovery
|
|
46309
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46310
|
-
* @throws {RequiredError}
|
|
46311
|
-
*/
|
|
46312
|
-
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsTemplateBeta>>;
|
|
46313
|
-
};
|
|
46314
|
-
/**
|
|
46315
|
-
* ManualDiscoverApplicationsTemplateBetaApi - factory interface
|
|
46316
|
-
* @export
|
|
46317
|
-
*/
|
|
46318
|
-
export declare const ManualDiscoverApplicationsTemplateBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
46319
|
-
/**
|
|
46320
|
-
* 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\'.
|
|
46321
|
-
* @summary CSV template download for discovery
|
|
46322
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46323
|
-
* @throws {RequiredError}
|
|
46324
|
-
*/
|
|
46325
|
-
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsTemplateBeta>;
|
|
46326
|
-
};
|
|
46327
|
-
/**
|
|
46328
|
-
* ManualDiscoverApplicationsTemplateBetaApi - object-oriented interface
|
|
46329
|
-
* @export
|
|
46330
|
-
* @class ManualDiscoverApplicationsTemplateBetaApi
|
|
46331
|
-
* @extends {BaseAPI}
|
|
46332
|
-
*/
|
|
46333
|
-
export declare class ManualDiscoverApplicationsTemplateBetaApi extends BaseAPI {
|
|
46334
|
-
/**
|
|
46335
|
-
* 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\'.
|
|
46336
|
-
* @summary CSV template download for discovery
|
|
46337
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
46338
|
-
* @throws {RequiredError}
|
|
46339
|
-
* @memberof ManualDiscoverApplicationsTemplateBetaApi
|
|
46340
|
-
*/
|
|
46341
|
-
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualDiscoverApplicationsTemplateBeta, any>>;
|
|
46342
|
-
}
|
|
46343
46443
|
/**
|
|
46344
46444
|
* NonEmployeeLifecycleManagementBetaApi - axios parameter creator
|
|
46345
46445
|
* @export
|
|
@@ -59367,13 +59467,6 @@ export declare const VendorConnectorMappingsBetaApiAxiosParamCreator: (configura
|
|
|
59367
59467
|
* @throws {RequiredError}
|
|
59368
59468
|
*/
|
|
59369
59469
|
deleteVendorConnectorMapping: (vendorConnectorMappingBeta: VendorConnectorMappingBeta, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59370
|
-
/**
|
|
59371
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
59372
|
-
* @summary List vendor connector mappings
|
|
59373
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59374
|
-
* @throws {RequiredError}
|
|
59375
|
-
*/
|
|
59376
|
-
getVendorConnectorMappings: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59377
59470
|
};
|
|
59378
59471
|
/**
|
|
59379
59472
|
* VendorConnectorMappingsBetaApi - functional programming interface
|
|
@@ -59396,13 +59489,6 @@ export declare const VendorConnectorMappingsBetaApiFp: (configuration?: Configur
|
|
|
59396
59489
|
* @throws {RequiredError}
|
|
59397
59490
|
*/
|
|
59398
59491
|
deleteVendorConnectorMapping(vendorConnectorMappingBeta: VendorConnectorMappingBeta, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteVendorConnectorMapping200ResponseBeta>>;
|
|
59399
|
-
/**
|
|
59400
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
59401
|
-
* @summary List vendor connector mappings
|
|
59402
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59403
|
-
* @throws {RequiredError}
|
|
59404
|
-
*/
|
|
59405
|
-
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMappingBeta>>>;
|
|
59406
59492
|
};
|
|
59407
59493
|
/**
|
|
59408
59494
|
* VendorConnectorMappingsBetaApi - factory interface
|
|
@@ -59425,13 +59511,6 @@ export declare const VendorConnectorMappingsBetaApiFactory: (configuration?: Con
|
|
|
59425
59511
|
* @throws {RequiredError}
|
|
59426
59512
|
*/
|
|
59427
59513
|
deleteVendorConnectorMapping(vendorConnectorMappingBeta: VendorConnectorMappingBeta, axiosOptions?: any): AxiosPromise<DeleteVendorConnectorMapping200ResponseBeta>;
|
|
59428
|
-
/**
|
|
59429
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
59430
|
-
* @summary List vendor connector mappings
|
|
59431
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59432
|
-
* @throws {RequiredError}
|
|
59433
|
-
*/
|
|
59434
|
-
getVendorConnectorMappings(axiosOptions?: any): AxiosPromise<Array<VendorConnectorMappingBeta>>;
|
|
59435
59514
|
};
|
|
59436
59515
|
/**
|
|
59437
59516
|
* Request parameters for createVendorConnectorMapping operation in VendorConnectorMappingsBetaApi.
|
|
@@ -59484,14 +59563,6 @@ export declare class VendorConnectorMappingsBetaApi extends BaseAPI {
|
|
|
59484
59563
|
* @memberof VendorConnectorMappingsBetaApi
|
|
59485
59564
|
*/
|
|
59486
59565
|
deleteVendorConnectorMapping(requestParameters: VendorConnectorMappingsBetaApiDeleteVendorConnectorMappingRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteVendorConnectorMapping200ResponseBeta, any>>;
|
|
59487
|
-
/**
|
|
59488
|
-
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
59489
|
-
* @summary List vendor connector mappings
|
|
59490
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
59491
|
-
* @throws {RequiredError}
|
|
59492
|
-
* @memberof VendorConnectorMappingsBetaApi
|
|
59493
|
-
*/
|
|
59494
|
-
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMappingBeta[], any>>;
|
|
59495
59566
|
}
|
|
59496
59567
|
/**
|
|
59497
59568
|
* WorkItemsBetaApi - axios parameter creator
|