sailpoint-api-client 1.2.2 → 1.2.3
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 +2238 -188
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/cc/README.md +2 -2
- package/cc/common.ts +2 -2
- package/cc/package.json +1 -1
- package/dist/beta/api.d.ts +1910 -134
- package/dist/beta/api.js +985 -157
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/cc/common.js +2 -2
- package/dist/paginator.d.ts +1 -10
- package/dist/paginator.js +10 -6
- package/dist/paginator.js.map +1 -1
- package/dist/v2/common.js +2 -2
- package/dist/v3/api.d.ts +1138 -113
- package/dist/v3/api.js +1300 -42
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/package.json +2 -2
- package/paginator.ts +105 -89
- package/v2/README.md +2 -2
- package/v2/common.ts +2 -2
- package/v2/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +1734 -123
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -2291,6 +2291,25 @@ export interface AccountUnlockRequest {
|
|
|
2291
2291
|
*/
|
|
2292
2292
|
'forceProvisioning'?: boolean;
|
|
2293
2293
|
}
|
|
2294
|
+
/**
|
|
2295
|
+
*
|
|
2296
|
+
* @export
|
|
2297
|
+
* @interface AccountUsage
|
|
2298
|
+
*/
|
|
2299
|
+
export interface AccountUsage {
|
|
2300
|
+
/**
|
|
2301
|
+
* The first day of the month for which activity is aggregated.
|
|
2302
|
+
* @type {string}
|
|
2303
|
+
* @memberof AccountUsage
|
|
2304
|
+
*/
|
|
2305
|
+
'date'?: string;
|
|
2306
|
+
/**
|
|
2307
|
+
* The number of days within the month that the account was active in a source.
|
|
2308
|
+
* @type {number}
|
|
2309
|
+
* @memberof AccountUsage
|
|
2310
|
+
*/
|
|
2311
|
+
'count'?: number;
|
|
2312
|
+
}
|
|
2294
2313
|
/**
|
|
2295
2314
|
* Accounts async response containing details on started async process
|
|
2296
2315
|
* @export
|
|
@@ -4474,6 +4493,102 @@ export interface CampaignReportsConfig {
|
|
|
4474
4493
|
*/
|
|
4475
4494
|
'identityAttributeColumns'?: Array<string>;
|
|
4476
4495
|
}
|
|
4496
|
+
/**
|
|
4497
|
+
* Campaign Template
|
|
4498
|
+
* @export
|
|
4499
|
+
* @interface CampaignTemplate
|
|
4500
|
+
*/
|
|
4501
|
+
export interface CampaignTemplate {
|
|
4502
|
+
/**
|
|
4503
|
+
* Id of the campaign template
|
|
4504
|
+
* @type {string}
|
|
4505
|
+
* @memberof CampaignTemplate
|
|
4506
|
+
*/
|
|
4507
|
+
'id'?: string;
|
|
4508
|
+
/**
|
|
4509
|
+
* This template\'s name. Has no bearing on generated campaigns\' names.
|
|
4510
|
+
* @type {string}
|
|
4511
|
+
* @memberof CampaignTemplate
|
|
4512
|
+
*/
|
|
4513
|
+
'name': string;
|
|
4514
|
+
/**
|
|
4515
|
+
* This template\'s description. Has no bearing on generated campaigns\' descriptions.
|
|
4516
|
+
* @type {string}
|
|
4517
|
+
* @memberof CampaignTemplate
|
|
4518
|
+
*/
|
|
4519
|
+
'description': string;
|
|
4520
|
+
/**
|
|
4521
|
+
* Creation date of Campaign Template
|
|
4522
|
+
* @type {string}
|
|
4523
|
+
* @memberof CampaignTemplate
|
|
4524
|
+
*/
|
|
4525
|
+
'created': string;
|
|
4526
|
+
/**
|
|
4527
|
+
* Modification date of Campaign Template
|
|
4528
|
+
* @type {string}
|
|
4529
|
+
* @memberof CampaignTemplate
|
|
4530
|
+
*/
|
|
4531
|
+
'modified': string;
|
|
4532
|
+
/**
|
|
4533
|
+
* Indicates if this campaign template has been scheduled.
|
|
4534
|
+
* @type {boolean}
|
|
4535
|
+
* @memberof CampaignTemplate
|
|
4536
|
+
*/
|
|
4537
|
+
'scheduled'?: boolean;
|
|
4538
|
+
/**
|
|
4539
|
+
*
|
|
4540
|
+
* @type {CampaignTemplateOwnerRef}
|
|
4541
|
+
* @memberof CampaignTemplate
|
|
4542
|
+
*/
|
|
4543
|
+
'ownerRef'?: CampaignTemplateOwnerRef;
|
|
4544
|
+
/**
|
|
4545
|
+
* The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days).
|
|
4546
|
+
* @type {string}
|
|
4547
|
+
* @memberof CampaignTemplate
|
|
4548
|
+
*/
|
|
4549
|
+
'deadlineDuration'?: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* This will hold campaign related information like name, description etc.
|
|
4552
|
+
* @type {Campaign}
|
|
4553
|
+
* @memberof CampaignTemplate
|
|
4554
|
+
*/
|
|
4555
|
+
'campaign': Campaign;
|
|
4556
|
+
}
|
|
4557
|
+
/**
|
|
4558
|
+
* The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
|
|
4559
|
+
* @export
|
|
4560
|
+
* @interface CampaignTemplateOwnerRef
|
|
4561
|
+
*/
|
|
4562
|
+
export interface CampaignTemplateOwnerRef {
|
|
4563
|
+
/**
|
|
4564
|
+
* Id of the owner
|
|
4565
|
+
* @type {string}
|
|
4566
|
+
* @memberof CampaignTemplateOwnerRef
|
|
4567
|
+
*/
|
|
4568
|
+
'id'?: string;
|
|
4569
|
+
/**
|
|
4570
|
+
* Type of the owner
|
|
4571
|
+
* @type {string}
|
|
4572
|
+
* @memberof CampaignTemplateOwnerRef
|
|
4573
|
+
*/
|
|
4574
|
+
'type'?: CampaignTemplateOwnerRefTypeEnum;
|
|
4575
|
+
/**
|
|
4576
|
+
* Name of the owner
|
|
4577
|
+
* @type {string}
|
|
4578
|
+
* @memberof CampaignTemplateOwnerRef
|
|
4579
|
+
*/
|
|
4580
|
+
'name'?: string;
|
|
4581
|
+
/**
|
|
4582
|
+
* Email of the owner
|
|
4583
|
+
* @type {string}
|
|
4584
|
+
* @memberof CampaignTemplateOwnerRef
|
|
4585
|
+
*/
|
|
4586
|
+
'email'?: string;
|
|
4587
|
+
}
|
|
4588
|
+
export declare const CampaignTemplateOwnerRefTypeEnum: {
|
|
4589
|
+
readonly Identity: "IDENTITY";
|
|
4590
|
+
};
|
|
4591
|
+
export type CampaignTemplateOwnerRefTypeEnum = typeof CampaignTemplateOwnerRefTypeEnum[keyof typeof CampaignTemplateOwnerRefTypeEnum];
|
|
4477
4592
|
/**
|
|
4478
4593
|
*
|
|
4479
4594
|
* @export
|
|
@@ -7615,25 +7730,23 @@ export type IdentityAccess = AccessProfileEntitlement | AccessProfileRole | Acce
|
|
|
7615
7730
|
*/
|
|
7616
7731
|
export interface IdentityAttribute {
|
|
7617
7732
|
/**
|
|
7618
|
-
* The
|
|
7733
|
+
* The attribute key
|
|
7619
7734
|
* @type {string}
|
|
7620
7735
|
* @memberof IdentityAttribute
|
|
7621
7736
|
*/
|
|
7622
|
-
'
|
|
7737
|
+
'key'?: string;
|
|
7623
7738
|
/**
|
|
7624
|
-
*
|
|
7625
|
-
* @type {
|
|
7739
|
+
* Human-readable display name of the attribute
|
|
7740
|
+
* @type {string}
|
|
7626
7741
|
* @memberof IdentityAttribute
|
|
7627
7742
|
*/
|
|
7628
|
-
'
|
|
7743
|
+
'name'?: string;
|
|
7629
7744
|
/**
|
|
7630
|
-
*
|
|
7631
|
-
* @type {
|
|
7745
|
+
* The attribute value
|
|
7746
|
+
* @type {string}
|
|
7632
7747
|
* @memberof IdentityAttribute
|
|
7633
7748
|
*/
|
|
7634
|
-
'
|
|
7635
|
-
[key: string]: any;
|
|
7636
|
-
};
|
|
7749
|
+
'value'?: string;
|
|
7637
7750
|
}
|
|
7638
7751
|
/**
|
|
7639
7752
|
*
|
|
@@ -7642,23 +7755,25 @@ export interface IdentityAttribute {
|
|
|
7642
7755
|
*/
|
|
7643
7756
|
export interface IdentityAttribute1 {
|
|
7644
7757
|
/**
|
|
7645
|
-
* The attribute
|
|
7758
|
+
* The system (camel-cased) name of the identity attribute to bring in
|
|
7646
7759
|
* @type {string}
|
|
7647
7760
|
* @memberof IdentityAttribute1
|
|
7648
7761
|
*/
|
|
7649
|
-
'
|
|
7762
|
+
'name': string;
|
|
7650
7763
|
/**
|
|
7651
|
-
*
|
|
7652
|
-
* @type {
|
|
7764
|
+
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
7765
|
+
* @type {boolean}
|
|
7653
7766
|
* @memberof IdentityAttribute1
|
|
7654
7767
|
*/
|
|
7655
|
-
'
|
|
7768
|
+
'requiresPeriodicRefresh'?: boolean;
|
|
7656
7769
|
/**
|
|
7657
|
-
*
|
|
7658
|
-
* @type {string}
|
|
7770
|
+
* This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.
|
|
7771
|
+
* @type {{ [key: string]: any; }}
|
|
7659
7772
|
* @memberof IdentityAttribute1
|
|
7660
7773
|
*/
|
|
7661
|
-
'
|
|
7774
|
+
'input'?: {
|
|
7775
|
+
[key: string]: any;
|
|
7776
|
+
};
|
|
7662
7777
|
}
|
|
7663
7778
|
/**
|
|
7664
7779
|
* Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.
|
|
@@ -11760,10 +11875,10 @@ export interface PublicIdentity {
|
|
|
11760
11875
|
'manager'?: IdentityReference | null;
|
|
11761
11876
|
/**
|
|
11762
11877
|
* The public identity attributes of the identity
|
|
11763
|
-
* @type {Array<
|
|
11878
|
+
* @type {Array<IdentityAttribute>}
|
|
11764
11879
|
* @memberof PublicIdentity
|
|
11765
11880
|
*/
|
|
11766
|
-
'attributes'?: Array<
|
|
11881
|
+
'attributes'?: Array<IdentityAttribute>;
|
|
11767
11882
|
}
|
|
11768
11883
|
/**
|
|
11769
11884
|
* Used to map an attribute key for an Identity to its display name.
|
|
@@ -16055,6 +16170,43 @@ export declare const SourceSchemasInnerTypeEnum: {
|
|
|
16055
16170
|
readonly ConnectorSchema: "CONNECTOR_SCHEMA";
|
|
16056
16171
|
};
|
|
16057
16172
|
export type SourceSchemasInnerTypeEnum = typeof SourceSchemasInnerTypeEnum[keyof typeof SourceSchemasInnerTypeEnum];
|
|
16173
|
+
/**
|
|
16174
|
+
*
|
|
16175
|
+
* @export
|
|
16176
|
+
* @interface SourceUsage
|
|
16177
|
+
*/
|
|
16178
|
+
export interface SourceUsage {
|
|
16179
|
+
/**
|
|
16180
|
+
* The first day of the month for which activity is aggregated.
|
|
16181
|
+
* @type {string}
|
|
16182
|
+
* @memberof SourceUsage
|
|
16183
|
+
*/
|
|
16184
|
+
'date'?: string;
|
|
16185
|
+
/**
|
|
16186
|
+
* The average number of days that accounts were active within this source, for the month.
|
|
16187
|
+
* @type {number}
|
|
16188
|
+
* @memberof SourceUsage
|
|
16189
|
+
*/
|
|
16190
|
+
'count'?: number;
|
|
16191
|
+
}
|
|
16192
|
+
/**
|
|
16193
|
+
*
|
|
16194
|
+
* @export
|
|
16195
|
+
* @interface SourceUsageStatus
|
|
16196
|
+
*/
|
|
16197
|
+
export interface SourceUsageStatus {
|
|
16198
|
+
/**
|
|
16199
|
+
* Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source.
|
|
16200
|
+
* @type {string}
|
|
16201
|
+
* @memberof SourceUsageStatus
|
|
16202
|
+
*/
|
|
16203
|
+
'status'?: SourceUsageStatusStatusEnum;
|
|
16204
|
+
}
|
|
16205
|
+
export declare const SourceUsageStatusStatusEnum: {
|
|
16206
|
+
readonly Complete: "COMPLETE";
|
|
16207
|
+
readonly Incomplete: "INCOMPLETE";
|
|
16208
|
+
};
|
|
16209
|
+
export type SourceUsageStatusStatusEnum = typeof SourceUsageStatusStatusEnum[keyof typeof SourceUsageStatusStatusEnum];
|
|
16058
16210
|
/**
|
|
16059
16211
|
* Message model for Config Import/Export.
|
|
16060
16212
|
* @export
|
|
@@ -16368,17 +16520,17 @@ export interface TextQuery {
|
|
|
16368
16520
|
'contains'?: boolean;
|
|
16369
16521
|
}
|
|
16370
16522
|
/**
|
|
16371
|
-
*
|
|
16523
|
+
*
|
|
16372
16524
|
* @export
|
|
16373
16525
|
* @interface Transform
|
|
16374
16526
|
*/
|
|
16375
16527
|
export interface Transform {
|
|
16376
16528
|
/**
|
|
16377
|
-
*
|
|
16378
|
-
* @type {
|
|
16529
|
+
*
|
|
16530
|
+
* @type {TransformUpdateAttributes}
|
|
16379
16531
|
* @memberof Transform
|
|
16380
16532
|
*/
|
|
16381
|
-
'
|
|
16533
|
+
'attributes': TransformUpdateAttributes;
|
|
16382
16534
|
/**
|
|
16383
16535
|
* Unique name of this transform
|
|
16384
16536
|
* @type {string}
|
|
@@ -16391,18 +16543,6 @@ export interface Transform {
|
|
|
16391
16543
|
* @memberof Transform
|
|
16392
16544
|
*/
|
|
16393
16545
|
'type': TransformTypeEnum;
|
|
16394
|
-
/**
|
|
16395
|
-
*
|
|
16396
|
-
* @type {TransformAttributes}
|
|
16397
|
-
* @memberof Transform
|
|
16398
|
-
*/
|
|
16399
|
-
'attributes': TransformAttributes;
|
|
16400
|
-
/**
|
|
16401
|
-
* Indicates whether this is an internal SailPoint-created transform or a customer-created transform
|
|
16402
|
-
* @type {boolean}
|
|
16403
|
-
* @memberof Transform
|
|
16404
|
-
*/
|
|
16405
|
-
'internal'?: boolean;
|
|
16406
16546
|
}
|
|
16407
16547
|
export declare const TransformTypeEnum: {
|
|
16408
16548
|
readonly AccountAttribute: "accountAttribute";
|
|
@@ -16441,11 +16581,60 @@ export declare const TransformTypeEnum: {
|
|
|
16441
16581
|
};
|
|
16442
16582
|
export type TransformTypeEnum = typeof TransformTypeEnum[keyof typeof TransformTypeEnum];
|
|
16443
16583
|
/**
|
|
16444
|
-
*
|
|
16445
|
-
* Meta-data about the transform. Values in this list are specific to the type of transform to be executed.
|
|
16584
|
+
* The representation of an internally- or customer-defined transform.
|
|
16446
16585
|
* @export
|
|
16586
|
+
* @interface TransformAllOf
|
|
16447
16587
|
*/
|
|
16448
|
-
export
|
|
16588
|
+
export interface TransformAllOf {
|
|
16589
|
+
/**
|
|
16590
|
+
* Unique name of this transform
|
|
16591
|
+
* @type {string}
|
|
16592
|
+
* @memberof TransformAllOf
|
|
16593
|
+
*/
|
|
16594
|
+
'name': string;
|
|
16595
|
+
/**
|
|
16596
|
+
* The type of transform operation
|
|
16597
|
+
* @type {string}
|
|
16598
|
+
* @memberof TransformAllOf
|
|
16599
|
+
*/
|
|
16600
|
+
'type': TransformAllOfTypeEnum;
|
|
16601
|
+
}
|
|
16602
|
+
export declare const TransformAllOfTypeEnum: {
|
|
16603
|
+
readonly AccountAttribute: "accountAttribute";
|
|
16604
|
+
readonly Base64Decode: "base64Decode";
|
|
16605
|
+
readonly Base64Encode: "base64Encode";
|
|
16606
|
+
readonly Concat: "concat";
|
|
16607
|
+
readonly Conditional: "conditional";
|
|
16608
|
+
readonly DateCompare: "dateCompare";
|
|
16609
|
+
readonly DateFormat: "dateFormat";
|
|
16610
|
+
readonly DateMath: "dateMath";
|
|
16611
|
+
readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks";
|
|
16612
|
+
readonly E164phone: "e164phone";
|
|
16613
|
+
readonly FirstValid: "firstValid";
|
|
16614
|
+
readonly Rule: "rule";
|
|
16615
|
+
readonly IdentityAttribute: "identityAttribute";
|
|
16616
|
+
readonly IndexOf: "indexOf";
|
|
16617
|
+
readonly Iso3166: "iso3166";
|
|
16618
|
+
readonly LastIndexOf: "lastIndexOf";
|
|
16619
|
+
readonly LeftPad: "leftPad";
|
|
16620
|
+
readonly Lookup: "lookup";
|
|
16621
|
+
readonly Lower: "lower";
|
|
16622
|
+
readonly NormalizeNames: "normalizeNames";
|
|
16623
|
+
readonly RandomAlphaNumeric: "randomAlphaNumeric";
|
|
16624
|
+
readonly RandomNumeric: "randomNumeric";
|
|
16625
|
+
readonly Reference: "reference";
|
|
16626
|
+
readonly ReplaceAll: "replaceAll";
|
|
16627
|
+
readonly Replace: "replace";
|
|
16628
|
+
readonly RightPad: "rightPad";
|
|
16629
|
+
readonly Split: "split";
|
|
16630
|
+
readonly Static: "static";
|
|
16631
|
+
readonly Substring: "substring";
|
|
16632
|
+
readonly Trim: "trim";
|
|
16633
|
+
readonly Upper: "upper";
|
|
16634
|
+
readonly UsernameGenerator: "usernameGenerator";
|
|
16635
|
+
readonly Uuid: "uuid";
|
|
16636
|
+
};
|
|
16637
|
+
export type TransformAllOfTypeEnum = typeof TransformAllOfTypeEnum[keyof typeof TransformAllOfTypeEnum];
|
|
16449
16638
|
/**
|
|
16450
16639
|
*
|
|
16451
16640
|
* @export
|
|
@@ -16477,76 +16666,193 @@ export interface TransformDefinitionAttributesValue {
|
|
|
16477
16666
|
/**
|
|
16478
16667
|
*
|
|
16479
16668
|
* @export
|
|
16480
|
-
* @interface
|
|
16669
|
+
* @interface TransformRead
|
|
16481
16670
|
*/
|
|
16482
|
-
export interface
|
|
16483
|
-
/**
|
|
16484
|
-
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
16485
|
-
* @type {boolean}
|
|
16486
|
-
* @memberof Trim
|
|
16487
|
-
*/
|
|
16488
|
-
'requiresPeriodicRefresh'?: boolean;
|
|
16671
|
+
export interface TransformRead {
|
|
16489
16672
|
/**
|
|
16490
|
-
*
|
|
16491
|
-
* @type {
|
|
16492
|
-
* @memberof
|
|
16673
|
+
*
|
|
16674
|
+
* @type {TransformUpdateAttributes}
|
|
16675
|
+
* @memberof TransformRead
|
|
16493
16676
|
*/
|
|
16494
|
-
'
|
|
16495
|
-
[key: string]: any;
|
|
16496
|
-
};
|
|
16497
|
-
}
|
|
16498
|
-
/**
|
|
16499
|
-
* Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\"
|
|
16500
|
-
* @export
|
|
16501
|
-
* @interface TypeAheadQuery
|
|
16502
|
-
*/
|
|
16503
|
-
export interface TypeAheadQuery {
|
|
16677
|
+
'attributes': TransformUpdateAttributes;
|
|
16504
16678
|
/**
|
|
16505
|
-
*
|
|
16679
|
+
* Unique name of this transform
|
|
16506
16680
|
* @type {string}
|
|
16507
|
-
* @memberof
|
|
16681
|
+
* @memberof TransformRead
|
|
16508
16682
|
*/
|
|
16509
|
-
'
|
|
16683
|
+
'name': string;
|
|
16510
16684
|
/**
|
|
16511
|
-
* The
|
|
16685
|
+
* The type of transform operation
|
|
16512
16686
|
* @type {string}
|
|
16513
|
-
* @memberof
|
|
16687
|
+
* @memberof TransformRead
|
|
16514
16688
|
*/
|
|
16515
|
-
'
|
|
16689
|
+
'type': TransformReadTypeEnum;
|
|
16516
16690
|
/**
|
|
16517
|
-
*
|
|
16691
|
+
* Unique ID of this transform
|
|
16518
16692
|
* @type {string}
|
|
16519
|
-
* @memberof
|
|
16520
|
-
*/
|
|
16521
|
-
'nestedType'?: string;
|
|
16522
|
-
/**
|
|
16523
|
-
* The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000.
|
|
16524
|
-
* @type {number}
|
|
16525
|
-
* @memberof TypeAheadQuery
|
|
16526
|
-
*/
|
|
16527
|
-
'maxExpansions'?: number;
|
|
16528
|
-
}
|
|
16529
|
-
/**
|
|
16530
|
-
* A typed reference to the object.
|
|
16531
|
-
* @export
|
|
16532
|
-
* @interface TypedReference
|
|
16533
|
-
*/
|
|
16534
|
-
export interface TypedReference {
|
|
16535
|
-
/**
|
|
16536
|
-
*
|
|
16537
|
-
* @type {DtoType}
|
|
16538
|
-
* @memberof TypedReference
|
|
16693
|
+
* @memberof TransformRead
|
|
16539
16694
|
*/
|
|
16540
|
-
'
|
|
16695
|
+
'id': string;
|
|
16541
16696
|
/**
|
|
16542
|
-
*
|
|
16543
|
-
* @type {
|
|
16544
|
-
* @memberof
|
|
16697
|
+
* Indicates whether this is an internal SailPoint-created transform or a customer-created transform
|
|
16698
|
+
* @type {boolean}
|
|
16699
|
+
* @memberof TransformRead
|
|
16545
16700
|
*/
|
|
16546
|
-
'
|
|
16701
|
+
'internal'?: boolean;
|
|
16547
16702
|
}
|
|
16548
|
-
|
|
16549
|
-
|
|
16703
|
+
export declare const TransformReadTypeEnum: {
|
|
16704
|
+
readonly AccountAttribute: "accountAttribute";
|
|
16705
|
+
readonly Base64Decode: "base64Decode";
|
|
16706
|
+
readonly Base64Encode: "base64Encode";
|
|
16707
|
+
readonly Concat: "concat";
|
|
16708
|
+
readonly Conditional: "conditional";
|
|
16709
|
+
readonly DateCompare: "dateCompare";
|
|
16710
|
+
readonly DateFormat: "dateFormat";
|
|
16711
|
+
readonly DateMath: "dateMath";
|
|
16712
|
+
readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks";
|
|
16713
|
+
readonly E164phone: "e164phone";
|
|
16714
|
+
readonly FirstValid: "firstValid";
|
|
16715
|
+
readonly Rule: "rule";
|
|
16716
|
+
readonly IdentityAttribute: "identityAttribute";
|
|
16717
|
+
readonly IndexOf: "indexOf";
|
|
16718
|
+
readonly Iso3166: "iso3166";
|
|
16719
|
+
readonly LastIndexOf: "lastIndexOf";
|
|
16720
|
+
readonly LeftPad: "leftPad";
|
|
16721
|
+
readonly Lookup: "lookup";
|
|
16722
|
+
readonly Lower: "lower";
|
|
16723
|
+
readonly NormalizeNames: "normalizeNames";
|
|
16724
|
+
readonly RandomAlphaNumeric: "randomAlphaNumeric";
|
|
16725
|
+
readonly RandomNumeric: "randomNumeric";
|
|
16726
|
+
readonly Reference: "reference";
|
|
16727
|
+
readonly ReplaceAll: "replaceAll";
|
|
16728
|
+
readonly Replace: "replace";
|
|
16729
|
+
readonly RightPad: "rightPad";
|
|
16730
|
+
readonly Split: "split";
|
|
16731
|
+
readonly Static: "static";
|
|
16732
|
+
readonly Substring: "substring";
|
|
16733
|
+
readonly Trim: "trim";
|
|
16734
|
+
readonly Upper: "upper";
|
|
16735
|
+
readonly UsernameGenerator: "usernameGenerator";
|
|
16736
|
+
readonly Uuid: "uuid";
|
|
16737
|
+
};
|
|
16738
|
+
export type TransformReadTypeEnum = typeof TransformReadTypeEnum[keyof typeof TransformReadTypeEnum];
|
|
16739
|
+
/**
|
|
16740
|
+
*
|
|
16741
|
+
* @export
|
|
16742
|
+
* @interface TransformReadAllOf
|
|
16743
|
+
*/
|
|
16744
|
+
export interface TransformReadAllOf {
|
|
16745
|
+
/**
|
|
16746
|
+
* Unique ID of this transform
|
|
16747
|
+
* @type {string}
|
|
16748
|
+
* @memberof TransformReadAllOf
|
|
16749
|
+
*/
|
|
16750
|
+
'id': string;
|
|
16751
|
+
/**
|
|
16752
|
+
* Indicates whether this is an internal SailPoint-created transform or a customer-created transform
|
|
16753
|
+
* @type {boolean}
|
|
16754
|
+
* @memberof TransformReadAllOf
|
|
16755
|
+
*/
|
|
16756
|
+
'internal'?: boolean;
|
|
16757
|
+
}
|
|
16758
|
+
/**
|
|
16759
|
+
* The representation of an internally- or customer-defined transform.
|
|
16760
|
+
* @export
|
|
16761
|
+
* @interface TransformUpdate
|
|
16762
|
+
*/
|
|
16763
|
+
export interface TransformUpdate {
|
|
16764
|
+
/**
|
|
16765
|
+
*
|
|
16766
|
+
* @type {TransformUpdateAttributes}
|
|
16767
|
+
* @memberof TransformUpdate
|
|
16768
|
+
*/
|
|
16769
|
+
'attributes': TransformUpdateAttributes;
|
|
16770
|
+
}
|
|
16771
|
+
/**
|
|
16772
|
+
* @type TransformUpdateAttributes
|
|
16773
|
+
* Meta-data about the transform. Values in this list are specific to the type of transform to be executed.
|
|
16774
|
+
* @export
|
|
16775
|
+
*/
|
|
16776
|
+
export type TransformUpdateAttributes = AccountAttribute | Base64Decode | Base64Encode | Concatenation | Conditional | DateCompare | DateFormat | DateMath | DecomposeDiacriticalMarks | E164phone | FirstValid | ISO3166 | IdentityAttribute1 | IndexOf | LeftPad | Lookup | Lower | NameNormalizer | RandomAlphaNumeric | RandomNumeric | Reference | Replace | ReplaceAll | RightPad | Rule | Split | Static | Substring | Trim | UUIDGenerator | Upper;
|
|
16777
|
+
/**
|
|
16778
|
+
*
|
|
16779
|
+
* @export
|
|
16780
|
+
* @interface Trim
|
|
16781
|
+
*/
|
|
16782
|
+
export interface Trim {
|
|
16783
|
+
/**
|
|
16784
|
+
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
16785
|
+
* @type {boolean}
|
|
16786
|
+
* @memberof Trim
|
|
16787
|
+
*/
|
|
16788
|
+
'requiresPeriodicRefresh'?: boolean;
|
|
16789
|
+
/**
|
|
16790
|
+
* This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.
|
|
16791
|
+
* @type {{ [key: string]: any; }}
|
|
16792
|
+
* @memberof Trim
|
|
16793
|
+
*/
|
|
16794
|
+
'input'?: {
|
|
16795
|
+
[key: string]: any;
|
|
16796
|
+
};
|
|
16797
|
+
}
|
|
16798
|
+
/**
|
|
16799
|
+
* Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\"
|
|
16800
|
+
* @export
|
|
16801
|
+
* @interface TypeAheadQuery
|
|
16802
|
+
*/
|
|
16803
|
+
export interface TypeAheadQuery {
|
|
16804
|
+
/**
|
|
16805
|
+
* The type ahead query string used to construct a phrase prefix match query.
|
|
16806
|
+
* @type {string}
|
|
16807
|
+
* @memberof TypeAheadQuery
|
|
16808
|
+
*/
|
|
16809
|
+
'query': string;
|
|
16810
|
+
/**
|
|
16811
|
+
* The field on which to perform the type ahead search.
|
|
16812
|
+
* @type {string}
|
|
16813
|
+
* @memberof TypeAheadQuery
|
|
16814
|
+
*/
|
|
16815
|
+
'field': string;
|
|
16816
|
+
/**
|
|
16817
|
+
* The nested type.
|
|
16818
|
+
* @type {string}
|
|
16819
|
+
* @memberof TypeAheadQuery
|
|
16820
|
+
*/
|
|
16821
|
+
'nestedType'?: string;
|
|
16822
|
+
/**
|
|
16823
|
+
* The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000.
|
|
16824
|
+
* @type {number}
|
|
16825
|
+
* @memberof TypeAheadQuery
|
|
16826
|
+
*/
|
|
16827
|
+
'maxExpansions'?: number;
|
|
16828
|
+
/**
|
|
16829
|
+
* The max amount of records the search will return.
|
|
16830
|
+
* @type {number}
|
|
16831
|
+
* @memberof TypeAheadQuery
|
|
16832
|
+
*/
|
|
16833
|
+
'size'?: number;
|
|
16834
|
+
}
|
|
16835
|
+
/**
|
|
16836
|
+
* A typed reference to the object.
|
|
16837
|
+
* @export
|
|
16838
|
+
* @interface TypedReference
|
|
16839
|
+
*/
|
|
16840
|
+
export interface TypedReference {
|
|
16841
|
+
/**
|
|
16842
|
+
*
|
|
16843
|
+
* @type {DtoType}
|
|
16844
|
+
* @memberof TypedReference
|
|
16845
|
+
*/
|
|
16846
|
+
'type': DtoType;
|
|
16847
|
+
/**
|
|
16848
|
+
* The id of the object.
|
|
16849
|
+
* @type {string}
|
|
16850
|
+
* @memberof TypedReference
|
|
16851
|
+
*/
|
|
16852
|
+
'id': string;
|
|
16853
|
+
}
|
|
16854
|
+
/**
|
|
16855
|
+
*
|
|
16550
16856
|
* @export
|
|
16551
16857
|
* @interface UUIDGenerator
|
|
16552
16858
|
*/
|
|
@@ -18292,6 +18598,114 @@ export declare class AccountActivitiesApi extends BaseAPI {
|
|
|
18292
18598
|
*/
|
|
18293
18599
|
listAccountActivities(requestParameters?: AccountActivitiesApiListAccountActivitiesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountActivity[], any>>;
|
|
18294
18600
|
}
|
|
18601
|
+
/**
|
|
18602
|
+
* AccountUsagesApi - axios parameter creator
|
|
18603
|
+
* @export
|
|
18604
|
+
*/
|
|
18605
|
+
export declare const AccountUsagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18606
|
+
/**
|
|
18607
|
+
* This API returns a summary of account usage insights for past 12 months.
|
|
18608
|
+
* @summary Returns account usage insights
|
|
18609
|
+
* @param {string} accountId ID of IDN account
|
|
18610
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18611
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18612
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18613
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
18614
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18615
|
+
* @throws {RequiredError}
|
|
18616
|
+
*/
|
|
18617
|
+
getUsagesByAccountId: (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18618
|
+
};
|
|
18619
|
+
/**
|
|
18620
|
+
* AccountUsagesApi - functional programming interface
|
|
18621
|
+
* @export
|
|
18622
|
+
*/
|
|
18623
|
+
export declare const AccountUsagesApiFp: (configuration?: Configuration) => {
|
|
18624
|
+
/**
|
|
18625
|
+
* This API returns a summary of account usage insights for past 12 months.
|
|
18626
|
+
* @summary Returns account usage insights
|
|
18627
|
+
* @param {string} accountId ID of IDN account
|
|
18628
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18629
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18630
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18631
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
18632
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18633
|
+
* @throws {RequiredError}
|
|
18634
|
+
*/
|
|
18635
|
+
getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountUsage>>>;
|
|
18636
|
+
};
|
|
18637
|
+
/**
|
|
18638
|
+
* AccountUsagesApi - factory interface
|
|
18639
|
+
* @export
|
|
18640
|
+
*/
|
|
18641
|
+
export declare const AccountUsagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18642
|
+
/**
|
|
18643
|
+
* This API returns a summary of account usage insights for past 12 months.
|
|
18644
|
+
* @summary Returns account usage insights
|
|
18645
|
+
* @param {string} accountId ID of IDN account
|
|
18646
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18647
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18648
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18649
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
18650
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18651
|
+
* @throws {RequiredError}
|
|
18652
|
+
*/
|
|
18653
|
+
getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: any): AxiosPromise<Array<AccountUsage>>;
|
|
18654
|
+
};
|
|
18655
|
+
/**
|
|
18656
|
+
* Request parameters for getUsagesByAccountId operation in AccountUsagesApi.
|
|
18657
|
+
* @export
|
|
18658
|
+
* @interface AccountUsagesApiGetUsagesByAccountIdRequest
|
|
18659
|
+
*/
|
|
18660
|
+
export interface AccountUsagesApiGetUsagesByAccountIdRequest {
|
|
18661
|
+
/**
|
|
18662
|
+
* ID of IDN account
|
|
18663
|
+
* @type {string}
|
|
18664
|
+
* @memberof AccountUsagesApiGetUsagesByAccountId
|
|
18665
|
+
*/
|
|
18666
|
+
readonly accountId: string;
|
|
18667
|
+
/**
|
|
18668
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18669
|
+
* @type {number}
|
|
18670
|
+
* @memberof AccountUsagesApiGetUsagesByAccountId
|
|
18671
|
+
*/
|
|
18672
|
+
readonly limit?: number;
|
|
18673
|
+
/**
|
|
18674
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18675
|
+
* @type {number}
|
|
18676
|
+
* @memberof AccountUsagesApiGetUsagesByAccountId
|
|
18677
|
+
*/
|
|
18678
|
+
readonly offset?: number;
|
|
18679
|
+
/**
|
|
18680
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18681
|
+
* @type {boolean}
|
|
18682
|
+
* @memberof AccountUsagesApiGetUsagesByAccountId
|
|
18683
|
+
*/
|
|
18684
|
+
readonly count?: boolean;
|
|
18685
|
+
/**
|
|
18686
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
18687
|
+
* @type {string}
|
|
18688
|
+
* @memberof AccountUsagesApiGetUsagesByAccountId
|
|
18689
|
+
*/
|
|
18690
|
+
readonly sorters?: string;
|
|
18691
|
+
}
|
|
18692
|
+
/**
|
|
18693
|
+
* AccountUsagesApi - object-oriented interface
|
|
18694
|
+
* @export
|
|
18695
|
+
* @class AccountUsagesApi
|
|
18696
|
+
* @extends {BaseAPI}
|
|
18697
|
+
*/
|
|
18698
|
+
export declare class AccountUsagesApi extends BaseAPI {
|
|
18699
|
+
/**
|
|
18700
|
+
* This API returns a summary of account usage insights for past 12 months.
|
|
18701
|
+
* @summary Returns account usage insights
|
|
18702
|
+
* @param {AccountUsagesApiGetUsagesByAccountIdRequest} requestParameters Request parameters.
|
|
18703
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18704
|
+
* @throws {RequiredError}
|
|
18705
|
+
* @memberof AccountUsagesApi
|
|
18706
|
+
*/
|
|
18707
|
+
getUsagesByAccountId(requestParameters: AccountUsagesApiGetUsagesByAccountIdRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountUsage[], any>>;
|
|
18708
|
+
}
|
|
18295
18709
|
/**
|
|
18296
18710
|
* AccountsApi - axios parameter creator
|
|
18297
18711
|
* @export
|
|
@@ -19081,6 +19495,14 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
19081
19495
|
* @throws {RequiredError}
|
|
19082
19496
|
*/
|
|
19083
19497
|
createCampaign: (campaign: Campaign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19498
|
+
/**
|
|
19499
|
+
* Create a campaign Template based on campaign.
|
|
19500
|
+
* @summary Create a Campaign Template
|
|
19501
|
+
* @param {CampaignTemplate} campaignTemplate
|
|
19502
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19503
|
+
* @throws {RequiredError}
|
|
19504
|
+
*/
|
|
19505
|
+
createCampaignTemplate: (campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19084
19506
|
/**
|
|
19085
19507
|
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19086
19508
|
* @summary Deletes Campaigns
|
|
@@ -19125,6 +19547,18 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
19125
19547
|
* @throws {RequiredError}
|
|
19126
19548
|
*/
|
|
19127
19549
|
getCampaignReportsConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19550
|
+
/**
|
|
19551
|
+
* Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. All CampaignTemplates matching the query params
|
|
19552
|
+
* @summary List Campaign Templates
|
|
19553
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19554
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19555
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19556
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
19557
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields: **name, id**
|
|
19558
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19559
|
+
* @throws {RequiredError}
|
|
19560
|
+
*/
|
|
19561
|
+
listCampaignTemplates: (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19128
19562
|
/**
|
|
19129
19563
|
* 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.
|
|
19130
19564
|
* @summary Reassign Certifications
|
|
@@ -19134,6 +19568,15 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
19134
19568
|
* @throws {RequiredError}
|
|
19135
19569
|
*/
|
|
19136
19570
|
move: (id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19571
|
+
/**
|
|
19572
|
+
* Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19573
|
+
* @summary Update a Campaign Template
|
|
19574
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19575
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
19576
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19577
|
+
* @throws {RequiredError}
|
|
19578
|
+
*/
|
|
19579
|
+
patchCampaignTemplate: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19137
19580
|
/**
|
|
19138
19581
|
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19139
19582
|
* @summary Set Campaign Reports Configuration
|
|
@@ -19168,6 +19611,14 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
19168
19611
|
* @throws {RequiredError}
|
|
19169
19612
|
*/
|
|
19170
19613
|
startCampaignReport: (id: string, type: ReportType, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19614
|
+
/**
|
|
19615
|
+
* Generates a new campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields in order to 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\" will insert the current year; a campaign template named \"Campaign for %y\" would generate 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). Requires roles ORG_ADMIN.
|
|
19616
|
+
* @summary Generate a Campaign from Template
|
|
19617
|
+
* @param {string} id The ID of the campaign template to use for generation.
|
|
19618
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19619
|
+
* @throws {RequiredError}
|
|
19620
|
+
*/
|
|
19621
|
+
startGenerateCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19171
19622
|
/**
|
|
19172
19623
|
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19173
19624
|
* @summary Update a Campaign
|
|
@@ -19200,6 +19651,14 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
19200
19651
|
* @throws {RequiredError}
|
|
19201
19652
|
*/
|
|
19202
19653
|
createCampaign(campaign: Campaign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Campaign>>;
|
|
19654
|
+
/**
|
|
19655
|
+
* Create a campaign Template based on campaign.
|
|
19656
|
+
* @summary Create a Campaign Template
|
|
19657
|
+
* @param {CampaignTemplate} campaignTemplate
|
|
19658
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19659
|
+
* @throws {RequiredError}
|
|
19660
|
+
*/
|
|
19661
|
+
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
19203
19662
|
/**
|
|
19204
19663
|
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19205
19664
|
* @summary Deletes Campaigns
|
|
@@ -19244,6 +19703,18 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
19244
19703
|
* @throws {RequiredError}
|
|
19245
19704
|
*/
|
|
19246
19705
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
19706
|
+
/**
|
|
19707
|
+
* Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. All CampaignTemplates matching the query params
|
|
19708
|
+
* @summary List Campaign Templates
|
|
19709
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19710
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19711
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19712
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
19713
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields: **name, id**
|
|
19714
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19715
|
+
* @throws {RequiredError}
|
|
19716
|
+
*/
|
|
19717
|
+
listCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignTemplate>>>;
|
|
19247
19718
|
/**
|
|
19248
19719
|
* 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.
|
|
19249
19720
|
* @summary Reassign Certifications
|
|
@@ -19253,6 +19724,15 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
19253
19724
|
* @throws {RequiredError}
|
|
19254
19725
|
*/
|
|
19255
19726
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
19727
|
+
/**
|
|
19728
|
+
* Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19729
|
+
* @summary Update a Campaign Template
|
|
19730
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19731
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
19732
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19733
|
+
* @throws {RequiredError}
|
|
19734
|
+
*/
|
|
19735
|
+
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
19256
19736
|
/**
|
|
19257
19737
|
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19258
19738
|
* @summary Set Campaign Reports Configuration
|
|
@@ -19287,6 +19767,14 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
19287
19767
|
* @throws {RequiredError}
|
|
19288
19768
|
*/
|
|
19289
19769
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
19770
|
+
/**
|
|
19771
|
+
* Generates a new campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields in order to 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\" will insert the current year; a campaign template named \"Campaign for %y\" would generate 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). Requires roles ORG_ADMIN.
|
|
19772
|
+
* @summary Generate a Campaign from Template
|
|
19773
|
+
* @param {string} id The ID of the campaign template to use for generation.
|
|
19774
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19775
|
+
* @throws {RequiredError}
|
|
19776
|
+
*/
|
|
19777
|
+
startGenerateCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReference>>;
|
|
19290
19778
|
/**
|
|
19291
19779
|
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19292
19780
|
* @summary Update a Campaign
|
|
@@ -19319,6 +19807,14 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
19319
19807
|
* @throws {RequiredError}
|
|
19320
19808
|
*/
|
|
19321
19809
|
createCampaign(campaign: Campaign, axiosOptions?: any): AxiosPromise<Campaign>;
|
|
19810
|
+
/**
|
|
19811
|
+
* Create a campaign Template based on campaign.
|
|
19812
|
+
* @summary Create a Campaign Template
|
|
19813
|
+
* @param {CampaignTemplate} campaignTemplate
|
|
19814
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19815
|
+
* @throws {RequiredError}
|
|
19816
|
+
*/
|
|
19817
|
+
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
19322
19818
|
/**
|
|
19323
19819
|
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19324
19820
|
* @summary Deletes Campaigns
|
|
@@ -19363,6 +19859,18 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
19363
19859
|
* @throws {RequiredError}
|
|
19364
19860
|
*/
|
|
19365
19861
|
getCampaignReportsConfig(axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
19862
|
+
/**
|
|
19863
|
+
* Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. All CampaignTemplates matching the query params
|
|
19864
|
+
* @summary List Campaign Templates
|
|
19865
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19866
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19867
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
19868
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
19869
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields: **name, id**
|
|
19870
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19871
|
+
* @throws {RequiredError}
|
|
19872
|
+
*/
|
|
19873
|
+
listCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<CampaignTemplate>>;
|
|
19366
19874
|
/**
|
|
19367
19875
|
* 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.
|
|
19368
19876
|
* @summary Reassign Certifications
|
|
@@ -19372,6 +19880,15 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
19372
19880
|
* @throws {RequiredError}
|
|
19373
19881
|
*/
|
|
19374
19882
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
19883
|
+
/**
|
|
19884
|
+
* Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19885
|
+
* @summary Update a Campaign Template
|
|
19886
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19887
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
19888
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19889
|
+
* @throws {RequiredError}
|
|
19890
|
+
*/
|
|
19891
|
+
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
19375
19892
|
/**
|
|
19376
19893
|
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19377
19894
|
* @summary Set Campaign Reports Configuration
|
|
@@ -19406,6 +19923,14 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
19406
19923
|
* @throws {RequiredError}
|
|
19407
19924
|
*/
|
|
19408
19925
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: any): AxiosPromise<object>;
|
|
19926
|
+
/**
|
|
19927
|
+
* Generates a new campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields in order to 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\" will insert the current year; a campaign template named \"Campaign for %y\" would generate 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). Requires roles ORG_ADMIN.
|
|
19928
|
+
* @summary Generate a Campaign from Template
|
|
19929
|
+
* @param {string} id The ID of the campaign template to use for generation.
|
|
19930
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19931
|
+
* @throws {RequiredError}
|
|
19932
|
+
*/
|
|
19933
|
+
startGenerateCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignReference>;
|
|
19409
19934
|
/**
|
|
19410
19935
|
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19411
19936
|
* @summary Update a Campaign
|
|
@@ -19448,6 +19973,19 @@ export interface CertificationCampaignsApiCreateCampaignRequest {
|
|
|
19448
19973
|
*/
|
|
19449
19974
|
readonly campaign: Campaign;
|
|
19450
19975
|
}
|
|
19976
|
+
/**
|
|
19977
|
+
* Request parameters for createCampaignTemplate operation in CertificationCampaignsApi.
|
|
19978
|
+
* @export
|
|
19979
|
+
* @interface CertificationCampaignsApiCreateCampaignTemplateRequest
|
|
19980
|
+
*/
|
|
19981
|
+
export interface CertificationCampaignsApiCreateCampaignTemplateRequest {
|
|
19982
|
+
/**
|
|
19983
|
+
*
|
|
19984
|
+
* @type {CampaignTemplate}
|
|
19985
|
+
* @memberof CertificationCampaignsApiCreateCampaignTemplate
|
|
19986
|
+
*/
|
|
19987
|
+
readonly campaignTemplate: CampaignTemplate;
|
|
19988
|
+
}
|
|
19451
19989
|
/**
|
|
19452
19990
|
* Request parameters for deleteCampaigns operation in CertificationCampaignsApi.
|
|
19453
19991
|
* @export
|
|
@@ -19530,6 +20068,43 @@ export interface CertificationCampaignsApiGetCampaignReportsRequest {
|
|
|
19530
20068
|
*/
|
|
19531
20069
|
readonly campaignId: string;
|
|
19532
20070
|
}
|
|
20071
|
+
/**
|
|
20072
|
+
* Request parameters for listCampaignTemplates operation in CertificationCampaignsApi.
|
|
20073
|
+
* @export
|
|
20074
|
+
* @interface CertificationCampaignsApiListCampaignTemplatesRequest
|
|
20075
|
+
*/
|
|
20076
|
+
export interface CertificationCampaignsApiListCampaignTemplatesRequest {
|
|
20077
|
+
/**
|
|
20078
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20079
|
+
* @type {number}
|
|
20080
|
+
* @memberof CertificationCampaignsApiListCampaignTemplates
|
|
20081
|
+
*/
|
|
20082
|
+
readonly limit?: number;
|
|
20083
|
+
/**
|
|
20084
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20085
|
+
* @type {number}
|
|
20086
|
+
* @memberof CertificationCampaignsApiListCampaignTemplates
|
|
20087
|
+
*/
|
|
20088
|
+
readonly offset?: number;
|
|
20089
|
+
/**
|
|
20090
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20091
|
+
* @type {boolean}
|
|
20092
|
+
* @memberof CertificationCampaignsApiListCampaignTemplates
|
|
20093
|
+
*/
|
|
20094
|
+
readonly count?: boolean;
|
|
20095
|
+
/**
|
|
20096
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
20097
|
+
* @type {string}
|
|
20098
|
+
* @memberof CertificationCampaignsApiListCampaignTemplates
|
|
20099
|
+
*/
|
|
20100
|
+
readonly sorters?: string;
|
|
20101
|
+
/**
|
|
20102
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields: **name, id**
|
|
20103
|
+
* @type {string}
|
|
20104
|
+
* @memberof CertificationCampaignsApiListCampaignTemplates
|
|
20105
|
+
*/
|
|
20106
|
+
readonly filters?: string;
|
|
20107
|
+
}
|
|
19533
20108
|
/**
|
|
19534
20109
|
* Request parameters for move operation in CertificationCampaignsApi.
|
|
19535
20110
|
* @export
|
|
@@ -19549,6 +20124,25 @@ export interface CertificationCampaignsApiMoveRequest {
|
|
|
19549
20124
|
*/
|
|
19550
20125
|
readonly adminReviewReassign: AdminReviewReassign;
|
|
19551
20126
|
}
|
|
20127
|
+
/**
|
|
20128
|
+
* Request parameters for patchCampaignTemplate operation in CertificationCampaignsApi.
|
|
20129
|
+
* @export
|
|
20130
|
+
* @interface CertificationCampaignsApiPatchCampaignTemplateRequest
|
|
20131
|
+
*/
|
|
20132
|
+
export interface CertificationCampaignsApiPatchCampaignTemplateRequest {
|
|
20133
|
+
/**
|
|
20134
|
+
* The ID of the campaign template being modified.
|
|
20135
|
+
* @type {string}
|
|
20136
|
+
* @memberof CertificationCampaignsApiPatchCampaignTemplate
|
|
20137
|
+
*/
|
|
20138
|
+
readonly id: string;
|
|
20139
|
+
/**
|
|
20140
|
+
* 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)
|
|
20141
|
+
* @type {Array<JsonPatchOperation>}
|
|
20142
|
+
* @memberof CertificationCampaignsApiPatchCampaignTemplate
|
|
20143
|
+
*/
|
|
20144
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
20145
|
+
}
|
|
19552
20146
|
/**
|
|
19553
20147
|
* Request parameters for setCampaignReportsConfig operation in CertificationCampaignsApi.
|
|
19554
20148
|
* @export
|
|
@@ -19613,6 +20207,19 @@ export interface CertificationCampaignsApiStartCampaignReportRequest {
|
|
|
19613
20207
|
*/
|
|
19614
20208
|
readonly type: ReportType;
|
|
19615
20209
|
}
|
|
20210
|
+
/**
|
|
20211
|
+
* Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsApi.
|
|
20212
|
+
* @export
|
|
20213
|
+
* @interface CertificationCampaignsApiStartGenerateCampaignTemplateRequest
|
|
20214
|
+
*/
|
|
20215
|
+
export interface CertificationCampaignsApiStartGenerateCampaignTemplateRequest {
|
|
20216
|
+
/**
|
|
20217
|
+
* The ID of the campaign template to use for generation.
|
|
20218
|
+
* @type {string}
|
|
20219
|
+
* @memberof CertificationCampaignsApiStartGenerateCampaignTemplate
|
|
20220
|
+
*/
|
|
20221
|
+
readonly id: string;
|
|
20222
|
+
}
|
|
19616
20223
|
/**
|
|
19617
20224
|
* Request parameters for updateCampaign operation in CertificationCampaignsApi.
|
|
19618
20225
|
* @export
|
|
@@ -19657,6 +20264,15 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
19657
20264
|
* @memberof CertificationCampaignsApi
|
|
19658
20265
|
*/
|
|
19659
20266
|
createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Campaign, any>>;
|
|
20267
|
+
/**
|
|
20268
|
+
* Create a campaign Template based on campaign.
|
|
20269
|
+
* @summary Create a Campaign Template
|
|
20270
|
+
* @param {CertificationCampaignsApiCreateCampaignTemplateRequest} requestParameters Request parameters.
|
|
20271
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20272
|
+
* @throws {RequiredError}
|
|
20273
|
+
* @memberof CertificationCampaignsApi
|
|
20274
|
+
*/
|
|
20275
|
+
createCampaignTemplate(requestParameters: CertificationCampaignsApiCreateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
19660
20276
|
/**
|
|
19661
20277
|
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19662
20278
|
* @summary Deletes Campaigns
|
|
@@ -19700,7 +20316,16 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
19700
20316
|
* @throws {RequiredError}
|
|
19701
20317
|
* @memberof CertificationCampaignsApi
|
|
19702
20318
|
*/
|
|
19703
|
-
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
20319
|
+
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
20320
|
+
/**
|
|
20321
|
+
* Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. All CampaignTemplates matching the query params
|
|
20322
|
+
* @summary List Campaign Templates
|
|
20323
|
+
* @param {CertificationCampaignsApiListCampaignTemplatesRequest} requestParameters Request parameters.
|
|
20324
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20325
|
+
* @throws {RequiredError}
|
|
20326
|
+
* @memberof CertificationCampaignsApi
|
|
20327
|
+
*/
|
|
20328
|
+
listCampaignTemplates(requestParameters?: CertificationCampaignsApiListCampaignTemplatesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate[], any>>;
|
|
19704
20329
|
/**
|
|
19705
20330
|
* 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.
|
|
19706
20331
|
* @summary Reassign Certifications
|
|
@@ -19710,6 +20335,15 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
19710
20335
|
* @memberof CertificationCampaignsApi
|
|
19711
20336
|
*/
|
|
19712
20337
|
move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
20338
|
+
/**
|
|
20339
|
+
* Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
20340
|
+
* @summary Update a Campaign Template
|
|
20341
|
+
* @param {CertificationCampaignsApiPatchCampaignTemplateRequest} requestParameters Request parameters.
|
|
20342
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20343
|
+
* @throws {RequiredError}
|
|
20344
|
+
* @memberof CertificationCampaignsApi
|
|
20345
|
+
*/
|
|
20346
|
+
patchCampaignTemplate(requestParameters: CertificationCampaignsApiPatchCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
19713
20347
|
/**
|
|
19714
20348
|
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19715
20349
|
* @summary Set Campaign Reports Configuration
|
|
@@ -19746,6 +20380,15 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
19746
20380
|
* @memberof CertificationCampaignsApi
|
|
19747
20381
|
*/
|
|
19748
20382
|
startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
20383
|
+
/**
|
|
20384
|
+
* Generates a new campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields in order to 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\" will insert the current year; a campaign template named \"Campaign for %y\" would generate 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). Requires roles ORG_ADMIN.
|
|
20385
|
+
* @summary Generate a Campaign from Template
|
|
20386
|
+
* @param {CertificationCampaignsApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters.
|
|
20387
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20388
|
+
* @throws {RequiredError}
|
|
20389
|
+
* @memberof CertificationCampaignsApi
|
|
20390
|
+
*/
|
|
20391
|
+
startGenerateCampaignTemplate(requestParameters: CertificationCampaignsApiStartGenerateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReference, any>>;
|
|
19749
20392
|
/**
|
|
19750
20393
|
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19751
20394
|
* @summary Update a Campaign
|
|
@@ -20104,6 +20747,31 @@ export declare const CertificationsApiAxiosParamCreator: (configuration?: Config
|
|
|
20104
20747
|
* @throws {RequiredError}
|
|
20105
20748
|
*/
|
|
20106
20749
|
getIdentityCertification: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20750
|
+
/**
|
|
20751
|
+
* This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20752
|
+
* @summary Permissions for Entitlement Certification Item
|
|
20753
|
+
* @param {string} certificationId The certification ID
|
|
20754
|
+
* @param {string} itemId The certification item ID
|
|
20755
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Supported fields and primitive operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, The following is valid: *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22* The following is invalid: *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
|
|
20756
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20757
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20758
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20759
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20760
|
+
* @throws {RequiredError}
|
|
20761
|
+
*/
|
|
20762
|
+
getIdentityCertificationItemPermissions: (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20763
|
+
/**
|
|
20764
|
+
* This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
|
|
20765
|
+
* @summary List of Pending Certification Tasks
|
|
20766
|
+
* @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user.
|
|
20767
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20768
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20769
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20770
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in*
|
|
20771
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20772
|
+
* @throws {RequiredError}
|
|
20773
|
+
*/
|
|
20774
|
+
getPendingCertificationTasks: (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20107
20775
|
/**
|
|
20108
20776
|
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20109
20777
|
* @summary List of Reviewers for certification
|
|
@@ -20172,6 +20840,15 @@ export declare const CertificationsApiAxiosParamCreator: (configuration?: Config
|
|
|
20172
20840
|
* @throws {RequiredError}
|
|
20173
20841
|
*/
|
|
20174
20842
|
signOffIdentityCertification: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20843
|
+
/**
|
|
20844
|
+
* This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20845
|
+
* @summary Reassign Certifications Asynchronously
|
|
20846
|
+
* @param {string} id The identity campaign certification ID
|
|
20847
|
+
* @param {ReviewReassign} reviewReassign
|
|
20848
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20849
|
+
* @throws {RequiredError}
|
|
20850
|
+
*/
|
|
20851
|
+
submitReassignCertsAsync: (id: string, reviewReassign: ReviewReassign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20175
20852
|
};
|
|
20176
20853
|
/**
|
|
20177
20854
|
* CertificationsApi - functional programming interface
|
|
@@ -20194,6 +20871,31 @@ export declare const CertificationsApiFp: (configuration?: Configuration) => {
|
|
|
20194
20871
|
* @throws {RequiredError}
|
|
20195
20872
|
*/
|
|
20196
20873
|
getIdentityCertification(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityCertificationDto>>;
|
|
20874
|
+
/**
|
|
20875
|
+
* This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20876
|
+
* @summary Permissions for Entitlement Certification Item
|
|
20877
|
+
* @param {string} certificationId The certification ID
|
|
20878
|
+
* @param {string} itemId The certification item ID
|
|
20879
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Supported fields and primitive operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, The following is valid: *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22* The following is invalid: *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
|
|
20880
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20881
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20882
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20883
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20884
|
+
* @throws {RequiredError}
|
|
20885
|
+
*/
|
|
20886
|
+
getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PermissionDto>>>;
|
|
20887
|
+
/**
|
|
20888
|
+
* This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
|
|
20889
|
+
* @summary List of Pending Certification Tasks
|
|
20890
|
+
* @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user.
|
|
20891
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20892
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20893
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20894
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in*
|
|
20895
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20896
|
+
* @throws {RequiredError}
|
|
20897
|
+
*/
|
|
20898
|
+
getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CertificationTask>>>;
|
|
20197
20899
|
/**
|
|
20198
20900
|
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20199
20901
|
* @summary List of Reviewers for certification
|
|
@@ -20262,6 +20964,15 @@ export declare const CertificationsApiFp: (configuration?: Configuration) => {
|
|
|
20262
20964
|
* @throws {RequiredError}
|
|
20263
20965
|
*/
|
|
20264
20966
|
signOffIdentityCertification(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityCertificationDto>>;
|
|
20967
|
+
/**
|
|
20968
|
+
* This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20969
|
+
* @summary Reassign Certifications Asynchronously
|
|
20970
|
+
* @param {string} id The identity campaign certification ID
|
|
20971
|
+
* @param {ReviewReassign} reviewReassign
|
|
20972
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20973
|
+
* @throws {RequiredError}
|
|
20974
|
+
*/
|
|
20975
|
+
submitReassignCertsAsync(id: string, reviewReassign: ReviewReassign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
20265
20976
|
};
|
|
20266
20977
|
/**
|
|
20267
20978
|
* CertificationsApi - factory interface
|
|
@@ -20284,6 +20995,31 @@ export declare const CertificationsApiFactory: (configuration?: Configuration, b
|
|
|
20284
20995
|
* @throws {RequiredError}
|
|
20285
20996
|
*/
|
|
20286
20997
|
getIdentityCertification(id: string, axiosOptions?: any): AxiosPromise<IdentityCertificationDto>;
|
|
20998
|
+
/**
|
|
20999
|
+
* This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
21000
|
+
* @summary Permissions for Entitlement Certification Item
|
|
21001
|
+
* @param {string} certificationId The certification ID
|
|
21002
|
+
* @param {string} itemId The certification item ID
|
|
21003
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Supported fields and primitive operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, The following is valid: *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22* The following is invalid: *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
|
|
21004
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21005
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21006
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21007
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21008
|
+
* @throws {RequiredError}
|
|
21009
|
+
*/
|
|
21010
|
+
getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<PermissionDto>>;
|
|
21011
|
+
/**
|
|
21012
|
+
* This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
|
|
21013
|
+
* @summary List of Pending Certification Tasks
|
|
21014
|
+
* @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user.
|
|
21015
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21016
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21017
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21018
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in*
|
|
21019
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21020
|
+
* @throws {RequiredError}
|
|
21021
|
+
*/
|
|
21022
|
+
getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: any): AxiosPromise<Array<CertificationTask>>;
|
|
20287
21023
|
/**
|
|
20288
21024
|
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20289
21025
|
* @summary List of Reviewers for certification
|
|
@@ -20352,6 +21088,15 @@ export declare const CertificationsApiFactory: (configuration?: Configuration, b
|
|
|
20352
21088
|
* @throws {RequiredError}
|
|
20353
21089
|
*/
|
|
20354
21090
|
signOffIdentityCertification(id: string, axiosOptions?: any): AxiosPromise<IdentityCertificationDto>;
|
|
21091
|
+
/**
|
|
21092
|
+
* This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
21093
|
+
* @summary Reassign Certifications Asynchronously
|
|
21094
|
+
* @param {string} id The identity campaign certification ID
|
|
21095
|
+
* @param {ReviewReassign} reviewReassign
|
|
21096
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21097
|
+
* @throws {RequiredError}
|
|
21098
|
+
*/
|
|
21099
|
+
submitReassignCertsAsync(id: string, reviewReassign: ReviewReassign, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
20355
21100
|
};
|
|
20356
21101
|
/**
|
|
20357
21102
|
* Request parameters for getCertificationTask operation in CertificationsApi.
|
|
@@ -20379,6 +21124,86 @@ export interface CertificationsApiGetIdentityCertificationRequest {
|
|
|
20379
21124
|
*/
|
|
20380
21125
|
readonly id: string;
|
|
20381
21126
|
}
|
|
21127
|
+
/**
|
|
21128
|
+
* Request parameters for getIdentityCertificationItemPermissions operation in CertificationsApi.
|
|
21129
|
+
* @export
|
|
21130
|
+
* @interface CertificationsApiGetIdentityCertificationItemPermissionsRequest
|
|
21131
|
+
*/
|
|
21132
|
+
export interface CertificationsApiGetIdentityCertificationItemPermissionsRequest {
|
|
21133
|
+
/**
|
|
21134
|
+
* The certification ID
|
|
21135
|
+
* @type {string}
|
|
21136
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21137
|
+
*/
|
|
21138
|
+
readonly certificationId: string;
|
|
21139
|
+
/**
|
|
21140
|
+
* The certification item ID
|
|
21141
|
+
* @type {string}
|
|
21142
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21143
|
+
*/
|
|
21144
|
+
readonly itemId: string;
|
|
21145
|
+
/**
|
|
21146
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Supported fields and primitive operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, The following is valid: *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22* The following is invalid: *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
|
|
21147
|
+
* @type {string}
|
|
21148
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21149
|
+
*/
|
|
21150
|
+
readonly filters?: string;
|
|
21151
|
+
/**
|
|
21152
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21153
|
+
* @type {number}
|
|
21154
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21155
|
+
*/
|
|
21156
|
+
readonly limit?: number;
|
|
21157
|
+
/**
|
|
21158
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21159
|
+
* @type {number}
|
|
21160
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21161
|
+
*/
|
|
21162
|
+
readonly offset?: number;
|
|
21163
|
+
/**
|
|
21164
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21165
|
+
* @type {boolean}
|
|
21166
|
+
* @memberof CertificationsApiGetIdentityCertificationItemPermissions
|
|
21167
|
+
*/
|
|
21168
|
+
readonly count?: boolean;
|
|
21169
|
+
}
|
|
21170
|
+
/**
|
|
21171
|
+
* Request parameters for getPendingCertificationTasks operation in CertificationsApi.
|
|
21172
|
+
* @export
|
|
21173
|
+
* @interface CertificationsApiGetPendingCertificationTasksRequest
|
|
21174
|
+
*/
|
|
21175
|
+
export interface CertificationsApiGetPendingCertificationTasksRequest {
|
|
21176
|
+
/**
|
|
21177
|
+
* The ID of reviewer identity. *me* indicates the current user.
|
|
21178
|
+
* @type {string}
|
|
21179
|
+
* @memberof CertificationsApiGetPendingCertificationTasks
|
|
21180
|
+
*/
|
|
21181
|
+
readonly reviewerIdentity?: string;
|
|
21182
|
+
/**
|
|
21183
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21184
|
+
* @type {number}
|
|
21185
|
+
* @memberof CertificationsApiGetPendingCertificationTasks
|
|
21186
|
+
*/
|
|
21187
|
+
readonly limit?: number;
|
|
21188
|
+
/**
|
|
21189
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21190
|
+
* @type {number}
|
|
21191
|
+
* @memberof CertificationsApiGetPendingCertificationTasks
|
|
21192
|
+
*/
|
|
21193
|
+
readonly offset?: number;
|
|
21194
|
+
/**
|
|
21195
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21196
|
+
* @type {boolean}
|
|
21197
|
+
* @memberof CertificationsApiGetPendingCertificationTasks
|
|
21198
|
+
*/
|
|
21199
|
+
readonly count?: boolean;
|
|
21200
|
+
/**
|
|
21201
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in*
|
|
21202
|
+
* @type {string}
|
|
21203
|
+
* @memberof CertificationsApiGetPendingCertificationTasks
|
|
21204
|
+
*/
|
|
21205
|
+
readonly filters?: string;
|
|
21206
|
+
}
|
|
20382
21207
|
/**
|
|
20383
21208
|
* Request parameters for listCertificationReviewers operation in CertificationsApi.
|
|
20384
21209
|
* @export
|
|
@@ -20577,6 +21402,25 @@ export interface CertificationsApiSignOffIdentityCertificationRequest {
|
|
|
20577
21402
|
*/
|
|
20578
21403
|
readonly id: string;
|
|
20579
21404
|
}
|
|
21405
|
+
/**
|
|
21406
|
+
* Request parameters for submitReassignCertsAsync operation in CertificationsApi.
|
|
21407
|
+
* @export
|
|
21408
|
+
* @interface CertificationsApiSubmitReassignCertsAsyncRequest
|
|
21409
|
+
*/
|
|
21410
|
+
export interface CertificationsApiSubmitReassignCertsAsyncRequest {
|
|
21411
|
+
/**
|
|
21412
|
+
* The identity campaign certification ID
|
|
21413
|
+
* @type {string}
|
|
21414
|
+
* @memberof CertificationsApiSubmitReassignCertsAsync
|
|
21415
|
+
*/
|
|
21416
|
+
readonly id: string;
|
|
21417
|
+
/**
|
|
21418
|
+
*
|
|
21419
|
+
* @type {ReviewReassign}
|
|
21420
|
+
* @memberof CertificationsApiSubmitReassignCertsAsync
|
|
21421
|
+
*/
|
|
21422
|
+
readonly reviewReassign: ReviewReassign;
|
|
21423
|
+
}
|
|
20580
21424
|
/**
|
|
20581
21425
|
* CertificationsApi - object-oriented interface
|
|
20582
21426
|
* @export
|
|
@@ -20602,6 +21446,24 @@ export declare class CertificationsApi extends BaseAPI {
|
|
|
20602
21446
|
* @memberof CertificationsApi
|
|
20603
21447
|
*/
|
|
20604
21448
|
getIdentityCertification(requestParameters: CertificationsApiGetIdentityCertificationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityCertificationDto, any>>;
|
|
21449
|
+
/**
|
|
21450
|
+
* This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
21451
|
+
* @summary Permissions for Entitlement Certification Item
|
|
21452
|
+
* @param {CertificationsApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters.
|
|
21453
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21454
|
+
* @throws {RequiredError}
|
|
21455
|
+
* @memberof CertificationsApi
|
|
21456
|
+
*/
|
|
21457
|
+
getIdentityCertificationItemPermissions(requestParameters: CertificationsApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PermissionDto[], any>>;
|
|
21458
|
+
/**
|
|
21459
|
+
* This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
|
|
21460
|
+
* @summary List of Pending Certification Tasks
|
|
21461
|
+
* @param {CertificationsApiGetPendingCertificationTasksRequest} requestParameters Request parameters.
|
|
21462
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21463
|
+
* @throws {RequiredError}
|
|
21464
|
+
* @memberof CertificationsApi
|
|
21465
|
+
*/
|
|
21466
|
+
getPendingCertificationTasks(requestParameters?: CertificationsApiGetPendingCertificationTasksRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask[], any>>;
|
|
20605
21467
|
/**
|
|
20606
21468
|
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20607
21469
|
* @summary List of Reviewers for certification
|
|
@@ -20656,6 +21518,15 @@ export declare class CertificationsApi extends BaseAPI {
|
|
|
20656
21518
|
* @memberof CertificationsApi
|
|
20657
21519
|
*/
|
|
20658
21520
|
signOffIdentityCertification(requestParameters: CertificationsApiSignOffIdentityCertificationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityCertificationDto, any>>;
|
|
21521
|
+
/**
|
|
21522
|
+
* This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
21523
|
+
* @summary Reassign Certifications Asynchronously
|
|
21524
|
+
* @param {CertificationsApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters.
|
|
21525
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21526
|
+
* @throws {RequiredError}
|
|
21527
|
+
* @memberof CertificationsApi
|
|
21528
|
+
*/
|
|
21529
|
+
submitReassignCertsAsync(requestParameters: CertificationsApiSubmitReassignCertsAsyncRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
20659
21530
|
}
|
|
20660
21531
|
/**
|
|
20661
21532
|
* GlobalTenantSecuritySettingsApi - axios parameter creator
|
|
@@ -28099,6 +28970,160 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
28099
28970
|
*/
|
|
28100
28971
|
updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedCheckConfigDetails, any>>;
|
|
28101
28972
|
}
|
|
28973
|
+
/**
|
|
28974
|
+
* SourceUsagesApi - axios parameter creator
|
|
28975
|
+
* @export
|
|
28976
|
+
*/
|
|
28977
|
+
export declare const SourceUsagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28978
|
+
/**
|
|
28979
|
+
* This API returns the status of the source usage insights setup by IDN source ID.
|
|
28980
|
+
* @summary Finds status of source usage
|
|
28981
|
+
* @param {string} sourceId ID of IDN source
|
|
28982
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
28983
|
+
* @throws {RequiredError}
|
|
28984
|
+
*/
|
|
28985
|
+
getStatusBySourceId: (sourceId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28986
|
+
/**
|
|
28987
|
+
* This API returns a summary of source usage insights for past 12 months.
|
|
28988
|
+
* @summary Returns source usage insights
|
|
28989
|
+
* @param {string} sourceId ID of IDN source
|
|
28990
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
28991
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
28992
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
28993
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
28994
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
28995
|
+
* @throws {RequiredError}
|
|
28996
|
+
*/
|
|
28997
|
+
getUsagesBySourceId: (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28998
|
+
};
|
|
28999
|
+
/**
|
|
29000
|
+
* SourceUsagesApi - functional programming interface
|
|
29001
|
+
* @export
|
|
29002
|
+
*/
|
|
29003
|
+
export declare const SourceUsagesApiFp: (configuration?: Configuration) => {
|
|
29004
|
+
/**
|
|
29005
|
+
* This API returns the status of the source usage insights setup by IDN source ID.
|
|
29006
|
+
* @summary Finds status of source usage
|
|
29007
|
+
* @param {string} sourceId ID of IDN source
|
|
29008
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29009
|
+
* @throws {RequiredError}
|
|
29010
|
+
*/
|
|
29011
|
+
getStatusBySourceId(sourceId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceUsageStatus>>;
|
|
29012
|
+
/**
|
|
29013
|
+
* This API returns a summary of source usage insights for past 12 months.
|
|
29014
|
+
* @summary Returns source usage insights
|
|
29015
|
+
* @param {string} sourceId ID of IDN source
|
|
29016
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29017
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29018
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29019
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
29020
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29021
|
+
* @throws {RequiredError}
|
|
29022
|
+
*/
|
|
29023
|
+
getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceUsage>>>;
|
|
29024
|
+
};
|
|
29025
|
+
/**
|
|
29026
|
+
* SourceUsagesApi - factory interface
|
|
29027
|
+
* @export
|
|
29028
|
+
*/
|
|
29029
|
+
export declare const SourceUsagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29030
|
+
/**
|
|
29031
|
+
* This API returns the status of the source usage insights setup by IDN source ID.
|
|
29032
|
+
* @summary Finds status of source usage
|
|
29033
|
+
* @param {string} sourceId ID of IDN source
|
|
29034
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29035
|
+
* @throws {RequiredError}
|
|
29036
|
+
*/
|
|
29037
|
+
getStatusBySourceId(sourceId: string, axiosOptions?: any): AxiosPromise<SourceUsageStatus>;
|
|
29038
|
+
/**
|
|
29039
|
+
* This API returns a summary of source usage insights for past 12 months.
|
|
29040
|
+
* @summary Returns source usage insights
|
|
29041
|
+
* @param {string} sourceId ID of IDN source
|
|
29042
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29043
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29044
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29045
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
29046
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29047
|
+
* @throws {RequiredError}
|
|
29048
|
+
*/
|
|
29049
|
+
getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: any): AxiosPromise<Array<SourceUsage>>;
|
|
29050
|
+
};
|
|
29051
|
+
/**
|
|
29052
|
+
* Request parameters for getStatusBySourceId operation in SourceUsagesApi.
|
|
29053
|
+
* @export
|
|
29054
|
+
* @interface SourceUsagesApiGetStatusBySourceIdRequest
|
|
29055
|
+
*/
|
|
29056
|
+
export interface SourceUsagesApiGetStatusBySourceIdRequest {
|
|
29057
|
+
/**
|
|
29058
|
+
* ID of IDN source
|
|
29059
|
+
* @type {string}
|
|
29060
|
+
* @memberof SourceUsagesApiGetStatusBySourceId
|
|
29061
|
+
*/
|
|
29062
|
+
readonly sourceId: string;
|
|
29063
|
+
}
|
|
29064
|
+
/**
|
|
29065
|
+
* Request parameters for getUsagesBySourceId operation in SourceUsagesApi.
|
|
29066
|
+
* @export
|
|
29067
|
+
* @interface SourceUsagesApiGetUsagesBySourceIdRequest
|
|
29068
|
+
*/
|
|
29069
|
+
export interface SourceUsagesApiGetUsagesBySourceIdRequest {
|
|
29070
|
+
/**
|
|
29071
|
+
* ID of IDN source
|
|
29072
|
+
* @type {string}
|
|
29073
|
+
* @memberof SourceUsagesApiGetUsagesBySourceId
|
|
29074
|
+
*/
|
|
29075
|
+
readonly sourceId: string;
|
|
29076
|
+
/**
|
|
29077
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29078
|
+
* @type {number}
|
|
29079
|
+
* @memberof SourceUsagesApiGetUsagesBySourceId
|
|
29080
|
+
*/
|
|
29081
|
+
readonly limit?: number;
|
|
29082
|
+
/**
|
|
29083
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29084
|
+
* @type {number}
|
|
29085
|
+
* @memberof SourceUsagesApiGetUsagesBySourceId
|
|
29086
|
+
*/
|
|
29087
|
+
readonly offset?: number;
|
|
29088
|
+
/**
|
|
29089
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
29090
|
+
* @type {boolean}
|
|
29091
|
+
* @memberof SourceUsagesApiGetUsagesBySourceId
|
|
29092
|
+
*/
|
|
29093
|
+
readonly count?: boolean;
|
|
29094
|
+
/**
|
|
29095
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
|
|
29096
|
+
* @type {string}
|
|
29097
|
+
* @memberof SourceUsagesApiGetUsagesBySourceId
|
|
29098
|
+
*/
|
|
29099
|
+
readonly sorters?: string;
|
|
29100
|
+
}
|
|
29101
|
+
/**
|
|
29102
|
+
* SourceUsagesApi - object-oriented interface
|
|
29103
|
+
* @export
|
|
29104
|
+
* @class SourceUsagesApi
|
|
29105
|
+
* @extends {BaseAPI}
|
|
29106
|
+
*/
|
|
29107
|
+
export declare class SourceUsagesApi extends BaseAPI {
|
|
29108
|
+
/**
|
|
29109
|
+
* This API returns the status of the source usage insights setup by IDN source ID.
|
|
29110
|
+
* @summary Finds status of source usage
|
|
29111
|
+
* @param {SourceUsagesApiGetStatusBySourceIdRequest} requestParameters Request parameters.
|
|
29112
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29113
|
+
* @throws {RequiredError}
|
|
29114
|
+
* @memberof SourceUsagesApi
|
|
29115
|
+
*/
|
|
29116
|
+
getStatusBySourceId(requestParameters: SourceUsagesApiGetStatusBySourceIdRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceUsageStatus, any>>;
|
|
29117
|
+
/**
|
|
29118
|
+
* This API returns a summary of source usage insights for past 12 months.
|
|
29119
|
+
* @summary Returns source usage insights
|
|
29120
|
+
* @param {SourceUsagesApiGetUsagesBySourceIdRequest} requestParameters Request parameters.
|
|
29121
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
29122
|
+
* @throws {RequiredError}
|
|
29123
|
+
* @memberof SourceUsagesApi
|
|
29124
|
+
*/
|
|
29125
|
+
getUsagesBySourceId(requestParameters: SourceUsagesApiGetUsagesBySourceIdRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceUsage[], any>>;
|
|
29126
|
+
}
|
|
28102
29127
|
/**
|
|
28103
29128
|
* SourcesApi - axios parameter creator
|
|
28104
29129
|
* @export
|
|
@@ -30074,11 +31099,11 @@ export declare const TransformsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
30074
31099
|
* Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API.
|
|
30075
31100
|
* @summary Update a transform
|
|
30076
31101
|
* @param {string} id ID of the transform to update
|
|
30077
|
-
* @param {
|
|
31102
|
+
* @param {TransformUpdate} [transformUpdate] The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).
|
|
30078
31103
|
* @param {*} [axiosOptions] Override http request option.
|
|
30079
31104
|
* @throws {RequiredError}
|
|
30080
31105
|
*/
|
|
30081
|
-
updateTransform: (id: string,
|
|
31106
|
+
updateTransform: (id: string, transformUpdate?: TransformUpdate, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30082
31107
|
};
|
|
30083
31108
|
/**
|
|
30084
31109
|
* TransformsApi - functional programming interface
|
|
@@ -30092,7 +31117,7 @@ export declare const TransformsApiFp: (configuration?: Configuration) => {
|
|
|
30092
31117
|
* @param {*} [axiosOptions] Override http request option.
|
|
30093
31118
|
* @throws {RequiredError}
|
|
30094
31119
|
*/
|
|
30095
|
-
createTransform(transform: Transform, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
31120
|
+
createTransform(transform: Transform, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransformRead>>;
|
|
30096
31121
|
/**
|
|
30097
31122
|
* Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API.
|
|
30098
31123
|
* @summary Delete a transform
|
|
@@ -30108,7 +31133,7 @@ export declare const TransformsApiFp: (configuration?: Configuration) => {
|
|
|
30108
31133
|
* @param {*} [axiosOptions] Override http request option.
|
|
30109
31134
|
* @throws {RequiredError}
|
|
30110
31135
|
*/
|
|
30111
|
-
getTransform(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
31136
|
+
getTransform(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransformRead>>;
|
|
30112
31137
|
/**
|
|
30113
31138
|
* Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API.
|
|
30114
31139
|
* @summary List transforms
|
|
@@ -30120,16 +31145,16 @@ export declare const TransformsApiFp: (configuration?: Configuration) => {
|
|
|
30120
31145
|
* @param {*} [axiosOptions] Override http request option.
|
|
30121
31146
|
* @throws {RequiredError}
|
|
30122
31147
|
*/
|
|
30123
|
-
listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
31148
|
+
listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransformRead>>>;
|
|
30124
31149
|
/**
|
|
30125
31150
|
* Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API.
|
|
30126
31151
|
* @summary Update a transform
|
|
30127
31152
|
* @param {string} id ID of the transform to update
|
|
30128
|
-
* @param {
|
|
31153
|
+
* @param {TransformUpdate} [transformUpdate] The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).
|
|
30129
31154
|
* @param {*} [axiosOptions] Override http request option.
|
|
30130
31155
|
* @throws {RequiredError}
|
|
30131
31156
|
*/
|
|
30132
|
-
updateTransform(id: string,
|
|
31157
|
+
updateTransform(id: string, transformUpdate?: TransformUpdate, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransformRead>>;
|
|
30133
31158
|
};
|
|
30134
31159
|
/**
|
|
30135
31160
|
* TransformsApi - factory interface
|
|
@@ -30143,7 +31168,7 @@ export declare const TransformsApiFactory: (configuration?: Configuration, baseP
|
|
|
30143
31168
|
* @param {*} [axiosOptions] Override http request option.
|
|
30144
31169
|
* @throws {RequiredError}
|
|
30145
31170
|
*/
|
|
30146
|
-
createTransform(transform: Transform, axiosOptions?: any): AxiosPromise<
|
|
31171
|
+
createTransform(transform: Transform, axiosOptions?: any): AxiosPromise<TransformRead>;
|
|
30147
31172
|
/**
|
|
30148
31173
|
* Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API.
|
|
30149
31174
|
* @summary Delete a transform
|
|
@@ -30159,7 +31184,7 @@ export declare const TransformsApiFactory: (configuration?: Configuration, baseP
|
|
|
30159
31184
|
* @param {*} [axiosOptions] Override http request option.
|
|
30160
31185
|
* @throws {RequiredError}
|
|
30161
31186
|
*/
|
|
30162
|
-
getTransform(id: string, axiosOptions?: any): AxiosPromise<
|
|
31187
|
+
getTransform(id: string, axiosOptions?: any): AxiosPromise<TransformRead>;
|
|
30163
31188
|
/**
|
|
30164
31189
|
* Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API.
|
|
30165
31190
|
* @summary List transforms
|
|
@@ -30171,16 +31196,16 @@ export declare const TransformsApiFactory: (configuration?: Configuration, baseP
|
|
|
30171
31196
|
* @param {*} [axiosOptions] Override http request option.
|
|
30172
31197
|
* @throws {RequiredError}
|
|
30173
31198
|
*/
|
|
30174
|
-
listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<
|
|
31199
|
+
listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<TransformRead>>;
|
|
30175
31200
|
/**
|
|
30176
31201
|
* Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API.
|
|
30177
31202
|
* @summary Update a transform
|
|
30178
31203
|
* @param {string} id ID of the transform to update
|
|
30179
|
-
* @param {
|
|
31204
|
+
* @param {TransformUpdate} [transformUpdate] The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).
|
|
30180
31205
|
* @param {*} [axiosOptions] Override http request option.
|
|
30181
31206
|
* @throws {RequiredError}
|
|
30182
31207
|
*/
|
|
30183
|
-
updateTransform(id: string,
|
|
31208
|
+
updateTransform(id: string, transformUpdate?: TransformUpdate, axiosOptions?: any): AxiosPromise<TransformRead>;
|
|
30184
31209
|
};
|
|
30185
31210
|
/**
|
|
30186
31211
|
* Request parameters for createTransform operation in TransformsApi.
|
|
@@ -30272,10 +31297,10 @@ export interface TransformsApiUpdateTransformRequest {
|
|
|
30272
31297
|
readonly id: string;
|
|
30273
31298
|
/**
|
|
30274
31299
|
* The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).
|
|
30275
|
-
* @type {
|
|
31300
|
+
* @type {TransformUpdate}
|
|
30276
31301
|
* @memberof TransformsApiUpdateTransform
|
|
30277
31302
|
*/
|
|
30278
|
-
readonly
|
|
31303
|
+
readonly transformUpdate?: TransformUpdate;
|
|
30279
31304
|
}
|
|
30280
31305
|
/**
|
|
30281
31306
|
* TransformsApi - object-oriented interface
|
|
@@ -30292,7 +31317,7 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
30292
31317
|
* @throws {RequiredError}
|
|
30293
31318
|
* @memberof TransformsApi
|
|
30294
31319
|
*/
|
|
30295
|
-
createTransform(requestParameters: TransformsApiCreateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
31320
|
+
createTransform(requestParameters: TransformsApiCreateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead, any>>;
|
|
30296
31321
|
/**
|
|
30297
31322
|
* Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API.
|
|
30298
31323
|
* @summary Delete a transform
|
|
@@ -30310,7 +31335,7 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
30310
31335
|
* @throws {RequiredError}
|
|
30311
31336
|
* @memberof TransformsApi
|
|
30312
31337
|
*/
|
|
30313
|
-
getTransform(requestParameters: TransformsApiGetTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
31338
|
+
getTransform(requestParameters: TransformsApiGetTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead, any>>;
|
|
30314
31339
|
/**
|
|
30315
31340
|
* Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API.
|
|
30316
31341
|
* @summary List transforms
|
|
@@ -30319,7 +31344,7 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
30319
31344
|
* @throws {RequiredError}
|
|
30320
31345
|
* @memberof TransformsApi
|
|
30321
31346
|
*/
|
|
30322
|
-
listTransforms(requestParameters?: TransformsApiListTransformsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
31347
|
+
listTransforms(requestParameters?: TransformsApiListTransformsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead[], any>>;
|
|
30323
31348
|
/**
|
|
30324
31349
|
* Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API.
|
|
30325
31350
|
* @summary Update a transform
|
|
@@ -30328,7 +31353,7 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
30328
31353
|
* @throws {RequiredError}
|
|
30329
31354
|
* @memberof TransformsApi
|
|
30330
31355
|
*/
|
|
30331
|
-
updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
31356
|
+
updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead, any>>;
|
|
30332
31357
|
}
|
|
30333
31358
|
/**
|
|
30334
31359
|
* WorkItemsApi - axios parameter creator
|