sailpoint-api-client 1.8.3 → 1.8.5
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 +309 -54
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +302 -53
- package/dist/beta/api.js +31 -26
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/v2024/api.d.ts +400 -273
- package/dist/v2024/api.js +228 -349
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.d.ts +399 -274
- package/dist/v2025/api.js +219 -342
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2026/common.js +2 -2
- package/dist/v3/api.d.ts +66 -0
- package/dist/v3/api.js +19 -9
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +526 -512
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +514 -503
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +72 -0
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2024/api.d.ts
CHANGED
|
@@ -13863,11 +13863,17 @@ export interface DkimAttributesV2024 {
|
|
|
13863
13863
|
*/
|
|
13864
13864
|
'dkimTokens'?: Array<string>;
|
|
13865
13865
|
/**
|
|
13866
|
-
* The current status if the domain /identity has been verified. Ie
|
|
13866
|
+
* The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING
|
|
13867
13867
|
* @type {string}
|
|
13868
13868
|
* @memberof DkimAttributesV2024
|
|
13869
13869
|
*/
|
|
13870
13870
|
'dkimVerificationStatus'?: string;
|
|
13871
|
+
/**
|
|
13872
|
+
* The AWS SES region the domain is associated with
|
|
13873
|
+
* @type {string}
|
|
13874
|
+
* @memberof DkimAttributesV2024
|
|
13875
|
+
*/
|
|
13876
|
+
'region'?: string;
|
|
13871
13877
|
}
|
|
13872
13878
|
/**
|
|
13873
13879
|
*
|
|
@@ -13953,10 +13959,10 @@ export interface DomainStatusDtoV2024 {
|
|
|
13953
13959
|
'domain'?: string;
|
|
13954
13960
|
/**
|
|
13955
13961
|
* DKIM is enabled for this domain
|
|
13956
|
-
* @type {
|
|
13962
|
+
* @type {boolean}
|
|
13957
13963
|
* @memberof DomainStatusDtoV2024
|
|
13958
13964
|
*/
|
|
13959
|
-
'dkimEnabled'?:
|
|
13965
|
+
'dkimEnabled'?: boolean;
|
|
13960
13966
|
/**
|
|
13961
13967
|
* DKIM tokens required for authentication
|
|
13962
13968
|
* @type {Array<string>}
|
|
@@ -13969,6 +13975,12 @@ export interface DomainStatusDtoV2024 {
|
|
|
13969
13975
|
* @memberof DomainStatusDtoV2024
|
|
13970
13976
|
*/
|
|
13971
13977
|
'dkimVerificationStatus'?: string;
|
|
13978
|
+
/**
|
|
13979
|
+
* The AWS SES region the domain is associated with
|
|
13980
|
+
* @type {string}
|
|
13981
|
+
* @memberof DomainStatusDtoV2024
|
|
13982
|
+
*/
|
|
13983
|
+
'region'?: string;
|
|
13972
13984
|
}
|
|
13973
13985
|
/**
|
|
13974
13986
|
*
|
|
@@ -14200,34 +14212,41 @@ export interface EmailNotificationOptionV2024 {
|
|
|
14200
14212
|
*/
|
|
14201
14213
|
export interface EmailStatusDtoV2024 {
|
|
14202
14214
|
/**
|
|
14203
|
-
*
|
|
14215
|
+
* Unique identifier for the verified sender address
|
|
14204
14216
|
* @type {string}
|
|
14205
14217
|
* @memberof EmailStatusDtoV2024
|
|
14206
14218
|
*/
|
|
14207
14219
|
'id'?: string | null;
|
|
14208
14220
|
/**
|
|
14209
|
-
*
|
|
14221
|
+
* The verified sender email address
|
|
14210
14222
|
* @type {string}
|
|
14211
14223
|
* @memberof EmailStatusDtoV2024
|
|
14212
14224
|
*/
|
|
14213
14225
|
'email'?: string;
|
|
14214
14226
|
/**
|
|
14215
|
-
*
|
|
14227
|
+
* Whether the sender address is verified by domain
|
|
14216
14228
|
* @type {boolean}
|
|
14217
14229
|
* @memberof EmailStatusDtoV2024
|
|
14218
14230
|
*/
|
|
14219
14231
|
'isVerifiedByDomain'?: boolean;
|
|
14220
14232
|
/**
|
|
14221
|
-
*
|
|
14233
|
+
* The verification status of the sender address
|
|
14222
14234
|
* @type {string}
|
|
14223
14235
|
* @memberof EmailStatusDtoV2024
|
|
14224
14236
|
*/
|
|
14225
14237
|
'verificationStatus'?: EmailStatusDtoV2024VerificationStatusV2024;
|
|
14238
|
+
/**
|
|
14239
|
+
* The AWS SES region the sender address is associated with
|
|
14240
|
+
* @type {string}
|
|
14241
|
+
* @memberof EmailStatusDtoV2024
|
|
14242
|
+
*/
|
|
14243
|
+
'region'?: string | null;
|
|
14226
14244
|
}
|
|
14227
14245
|
export declare const EmailStatusDtoV2024VerificationStatusV2024: {
|
|
14228
14246
|
readonly Pending: "PENDING";
|
|
14229
14247
|
readonly Success: "SUCCESS";
|
|
14230
14248
|
readonly Failed: "FAILED";
|
|
14249
|
+
readonly Na: "NA";
|
|
14231
14250
|
};
|
|
14232
14251
|
export type EmailStatusDtoV2024VerificationStatusV2024 = typeof EmailStatusDtoV2024VerificationStatusV2024[keyof typeof EmailStatusDtoV2024VerificationStatusV2024];
|
|
14233
14252
|
/**
|
|
@@ -14992,6 +15011,12 @@ export interface EntitlementV2024 {
|
|
|
14992
15011
|
* @memberof EntitlementV2024
|
|
14993
15012
|
*/
|
|
14994
15013
|
'owner'?: EntitlementOwnerV2024 | null;
|
|
15014
|
+
/**
|
|
15015
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
15016
|
+
* @type {Array<AdditionalOwnerRefV2024>}
|
|
15017
|
+
* @memberof EntitlementV2024
|
|
15018
|
+
*/
|
|
15019
|
+
'additionalOwners'?: Array<AdditionalOwnerRefV2024> | null;
|
|
14995
15020
|
/**
|
|
14996
15021
|
* A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
|
|
14997
15022
|
* @type {{ [key: string]: any; }}
|
|
@@ -17211,7 +17236,37 @@ export interface FullDiscoveredApplicationsV2024 {
|
|
|
17211
17236
|
* @memberof FullDiscoveredApplicationsV2024
|
|
17212
17237
|
*/
|
|
17213
17238
|
'associatedSources'?: Array<string>;
|
|
17239
|
+
/**
|
|
17240
|
+
* The risk score of the application ranging from 0-100, 100 being highest risk.
|
|
17241
|
+
* @type {number}
|
|
17242
|
+
* @memberof FullDiscoveredApplicationsV2024
|
|
17243
|
+
*/
|
|
17244
|
+
'riskScore'?: number;
|
|
17245
|
+
/**
|
|
17246
|
+
* Indicates whether the application is used for business purposes.
|
|
17247
|
+
* @type {boolean}
|
|
17248
|
+
* @memberof FullDiscoveredApplicationsV2024
|
|
17249
|
+
*/
|
|
17250
|
+
'isBusiness'?: boolean;
|
|
17251
|
+
/**
|
|
17252
|
+
* The total number of sign-in accounts for the application.
|
|
17253
|
+
* @type {number}
|
|
17254
|
+
* @memberof FullDiscoveredApplicationsV2024
|
|
17255
|
+
*/
|
|
17256
|
+
'totalSigninsCount'?: number;
|
|
17257
|
+
/**
|
|
17258
|
+
* The risk level of the application.
|
|
17259
|
+
* @type {string}
|
|
17260
|
+
* @memberof FullDiscoveredApplicationsV2024
|
|
17261
|
+
*/
|
|
17262
|
+
'riskLevel'?: FullDiscoveredApplicationsV2024RiskLevelV2024;
|
|
17214
17263
|
}
|
|
17264
|
+
export declare const FullDiscoveredApplicationsV2024RiskLevelV2024: {
|
|
17265
|
+
readonly High: "High";
|
|
17266
|
+
readonly Medium: "Medium";
|
|
17267
|
+
readonly Low: "Low";
|
|
17268
|
+
};
|
|
17269
|
+
export type FullDiscoveredApplicationsV2024RiskLevelV2024 = typeof FullDiscoveredApplicationsV2024RiskLevelV2024[keyof typeof FullDiscoveredApplicationsV2024RiskLevelV2024];
|
|
17215
17270
|
/**
|
|
17216
17271
|
*
|
|
17217
17272
|
* @export
|
|
@@ -24029,14 +24084,12 @@ export interface MatchTermV2024 {
|
|
|
24029
24084
|
}> | null;
|
|
24030
24085
|
}
|
|
24031
24086
|
/**
|
|
24032
|
-
*
|
|
24087
|
+
* The notification medium (EMAIL, SLACK, or TEAMS)
|
|
24033
24088
|
* @export
|
|
24034
24089
|
* @enum {string}
|
|
24035
24090
|
*/
|
|
24036
24091
|
export declare const MediumV2024: {
|
|
24037
24092
|
readonly Email: "EMAIL";
|
|
24038
|
-
readonly Sms: "SMS";
|
|
24039
|
-
readonly Phone: "PHONE";
|
|
24040
24093
|
readonly Slack: "SLACK";
|
|
24041
24094
|
readonly Teams: "TEAMS";
|
|
24042
24095
|
};
|
|
@@ -36766,12 +36819,36 @@ export interface SendTestNotificationRequestDtoV2024 {
|
|
|
36766
36819
|
* @memberof SendTestNotificationRequestDtoV2024
|
|
36767
36820
|
*/
|
|
36768
36821
|
'medium'?: SendTestNotificationRequestDtoV2024MediumV2024;
|
|
36822
|
+
/**
|
|
36823
|
+
* The locale for the message text.
|
|
36824
|
+
* @type {string}
|
|
36825
|
+
* @memberof SendTestNotificationRequestDtoV2024
|
|
36826
|
+
*/
|
|
36827
|
+
'locale'?: string;
|
|
36769
36828
|
/**
|
|
36770
36829
|
* A Json object that denotes the context specific to the template.
|
|
36771
36830
|
* @type {object}
|
|
36772
36831
|
* @memberof SendTestNotificationRequestDtoV2024
|
|
36773
36832
|
*/
|
|
36774
36833
|
'context'?: object;
|
|
36834
|
+
/**
|
|
36835
|
+
* A list of override recipient email addresses for the test notification.
|
|
36836
|
+
* @type {Array<string>}
|
|
36837
|
+
* @memberof SendTestNotificationRequestDtoV2024
|
|
36838
|
+
*/
|
|
36839
|
+
'recipientEmailList'?: Array<string>;
|
|
36840
|
+
/**
|
|
36841
|
+
* A list of CC email addresses for the test notification.
|
|
36842
|
+
* @type {Array<string>}
|
|
36843
|
+
* @memberof SendTestNotificationRequestDtoV2024
|
|
36844
|
+
*/
|
|
36845
|
+
'carbonCopy'?: Array<string>;
|
|
36846
|
+
/**
|
|
36847
|
+
* A list of BCC email addresses for the test notification.
|
|
36848
|
+
* @type {Array<string>}
|
|
36849
|
+
* @memberof SendTestNotificationRequestDtoV2024
|
|
36850
|
+
*/
|
|
36851
|
+
'blindCarbonCopy'?: Array<string>;
|
|
36775
36852
|
}
|
|
36776
36853
|
export declare const SendTestNotificationRequestDtoV2024MediumV2024: {
|
|
36777
36854
|
readonly Email: "EMAIL";
|
|
@@ -37475,7 +37552,37 @@ export interface SlimDiscoveredApplicationsV2024 {
|
|
|
37475
37552
|
* @memberof SlimDiscoveredApplicationsV2024
|
|
37476
37553
|
*/
|
|
37477
37554
|
'status'?: string;
|
|
37555
|
+
/**
|
|
37556
|
+
* The risk score of the application ranging from 0-100, 100 being highest risk.
|
|
37557
|
+
* @type {number}
|
|
37558
|
+
* @memberof SlimDiscoveredApplicationsV2024
|
|
37559
|
+
*/
|
|
37560
|
+
'riskScore'?: number;
|
|
37561
|
+
/**
|
|
37562
|
+
* Indicates whether the application is used for business purposes.
|
|
37563
|
+
* @type {boolean}
|
|
37564
|
+
* @memberof SlimDiscoveredApplicationsV2024
|
|
37565
|
+
*/
|
|
37566
|
+
'isBusiness'?: boolean;
|
|
37567
|
+
/**
|
|
37568
|
+
* The total number of sign-in accounts for the application.
|
|
37569
|
+
* @type {number}
|
|
37570
|
+
* @memberof SlimDiscoveredApplicationsV2024
|
|
37571
|
+
*/
|
|
37572
|
+
'totalSigninsCount'?: number;
|
|
37573
|
+
/**
|
|
37574
|
+
* The risk level of the application.
|
|
37575
|
+
* @type {string}
|
|
37576
|
+
* @memberof SlimDiscoveredApplicationsV2024
|
|
37577
|
+
*/
|
|
37578
|
+
'riskLevel'?: SlimDiscoveredApplicationsV2024RiskLevelV2024;
|
|
37478
37579
|
}
|
|
37580
|
+
export declare const SlimDiscoveredApplicationsV2024RiskLevelV2024: {
|
|
37581
|
+
readonly High: "High";
|
|
37582
|
+
readonly Medium: "Medium";
|
|
37583
|
+
readonly Low: "Low";
|
|
37584
|
+
};
|
|
37585
|
+
export type SlimDiscoveredApplicationsV2024RiskLevelV2024 = typeof SlimDiscoveredApplicationsV2024RiskLevelV2024[keyof typeof SlimDiscoveredApplicationsV2024RiskLevelV2024];
|
|
37479
37586
|
/**
|
|
37480
37587
|
* Details of the Entitlement criteria
|
|
37481
37588
|
* @export
|
|
@@ -41300,13 +41407,13 @@ export type TaskStatusV2024CompletionStatusV2024 = typeof TaskStatusV2024Complet
|
|
|
41300
41407
|
*/
|
|
41301
41408
|
export interface TemplateBulkDeleteDtoV2024 {
|
|
41302
41409
|
/**
|
|
41303
|
-
*
|
|
41410
|
+
* The template key to delete
|
|
41304
41411
|
* @type {string}
|
|
41305
41412
|
* @memberof TemplateBulkDeleteDtoV2024
|
|
41306
41413
|
*/
|
|
41307
41414
|
'key': string;
|
|
41308
41415
|
/**
|
|
41309
|
-
*
|
|
41416
|
+
* The notification medium (EMAIL, SLACK, or TEAMS)
|
|
41310
41417
|
* @type {string}
|
|
41311
41418
|
* @memberof TemplateBulkDeleteDtoV2024
|
|
41312
41419
|
*/
|
|
@@ -41320,8 +41427,8 @@ export interface TemplateBulkDeleteDtoV2024 {
|
|
|
41320
41427
|
}
|
|
41321
41428
|
export declare const TemplateBulkDeleteDtoV2024MediumV2024: {
|
|
41322
41429
|
readonly Email: "EMAIL";
|
|
41323
|
-
readonly
|
|
41324
|
-
readonly
|
|
41430
|
+
readonly Slack: "SLACK";
|
|
41431
|
+
readonly Teams: "TEAMS";
|
|
41325
41432
|
};
|
|
41326
41433
|
export type TemplateBulkDeleteDtoV2024MediumV2024 = typeof TemplateBulkDeleteDtoV2024MediumV2024[keyof typeof TemplateBulkDeleteDtoV2024MediumV2024];
|
|
41327
41434
|
/**
|
|
@@ -41413,12 +41520,156 @@ export interface TemplateDtoDefaultV2024 {
|
|
|
41413
41520
|
}
|
|
41414
41521
|
export declare const TemplateDtoDefaultV2024MediumV2024: {
|
|
41415
41522
|
readonly Email: "EMAIL";
|
|
41416
|
-
readonly Phone: "PHONE";
|
|
41417
|
-
readonly Sms: "SMS";
|
|
41418
41523
|
readonly Slack: "SLACK";
|
|
41419
41524
|
readonly Teams: "TEAMS";
|
|
41420
41525
|
};
|
|
41421
41526
|
export type TemplateDtoDefaultV2024MediumV2024 = typeof TemplateDtoDefaultV2024MediumV2024[keyof typeof TemplateDtoDefaultV2024MediumV2024];
|
|
41527
|
+
/**
|
|
41528
|
+
*
|
|
41529
|
+
* @export
|
|
41530
|
+
* @interface TemplateDtoSlackTemplateV2024
|
|
41531
|
+
*/
|
|
41532
|
+
export interface TemplateDtoSlackTemplateV2024 {
|
|
41533
|
+
/**
|
|
41534
|
+
* The template key
|
|
41535
|
+
* @type {string}
|
|
41536
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41537
|
+
*/
|
|
41538
|
+
'key'?: string | null;
|
|
41539
|
+
/**
|
|
41540
|
+
* The main text content of the Slack message
|
|
41541
|
+
* @type {string}
|
|
41542
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41543
|
+
*/
|
|
41544
|
+
'text'?: string;
|
|
41545
|
+
/**
|
|
41546
|
+
* JSON string of Slack Block Kit blocks for rich formatting
|
|
41547
|
+
* @type {string}
|
|
41548
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41549
|
+
*/
|
|
41550
|
+
'blocks'?: string | null;
|
|
41551
|
+
/**
|
|
41552
|
+
* JSON string of Slack attachments
|
|
41553
|
+
* @type {string}
|
|
41554
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41555
|
+
*/
|
|
41556
|
+
'attachments'?: string;
|
|
41557
|
+
/**
|
|
41558
|
+
* The type of notification
|
|
41559
|
+
* @type {string}
|
|
41560
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41561
|
+
*/
|
|
41562
|
+
'notificationType'?: string | null;
|
|
41563
|
+
/**
|
|
41564
|
+
* The approval request ID
|
|
41565
|
+
* @type {string}
|
|
41566
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41567
|
+
*/
|
|
41568
|
+
'approvalId'?: string | null;
|
|
41569
|
+
/**
|
|
41570
|
+
* The request ID
|
|
41571
|
+
* @type {string}
|
|
41572
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41573
|
+
*/
|
|
41574
|
+
'requestId'?: string | null;
|
|
41575
|
+
/**
|
|
41576
|
+
* The ID of the user who made the request
|
|
41577
|
+
* @type {string}
|
|
41578
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41579
|
+
*/
|
|
41580
|
+
'requestedById'?: string | null;
|
|
41581
|
+
/**
|
|
41582
|
+
* Whether this is a subscription notification
|
|
41583
|
+
* @type {boolean}
|
|
41584
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41585
|
+
*/
|
|
41586
|
+
'isSubscription'?: boolean | null;
|
|
41587
|
+
/**
|
|
41588
|
+
*
|
|
41589
|
+
* @type {TemplateSlackAutoApprovalDataV2024}
|
|
41590
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41591
|
+
*/
|
|
41592
|
+
'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null;
|
|
41593
|
+
/**
|
|
41594
|
+
*
|
|
41595
|
+
* @type {TemplateSlackCustomFieldsV2024}
|
|
41596
|
+
* @memberof TemplateDtoSlackTemplateV2024
|
|
41597
|
+
*/
|
|
41598
|
+
'customFields'?: TemplateSlackCustomFieldsV2024 | null;
|
|
41599
|
+
}
|
|
41600
|
+
/**
|
|
41601
|
+
*
|
|
41602
|
+
* @export
|
|
41603
|
+
* @interface TemplateDtoTeamsTemplateV2024
|
|
41604
|
+
*/
|
|
41605
|
+
export interface TemplateDtoTeamsTemplateV2024 {
|
|
41606
|
+
/**
|
|
41607
|
+
* The template key
|
|
41608
|
+
* @type {string}
|
|
41609
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41610
|
+
*/
|
|
41611
|
+
'key'?: string | null;
|
|
41612
|
+
/**
|
|
41613
|
+
* The title of the Teams message
|
|
41614
|
+
* @type {string}
|
|
41615
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41616
|
+
*/
|
|
41617
|
+
'title'?: string | null;
|
|
41618
|
+
/**
|
|
41619
|
+
* The main text content of the Teams message
|
|
41620
|
+
* @type {string}
|
|
41621
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41622
|
+
*/
|
|
41623
|
+
'text'?: string;
|
|
41624
|
+
/**
|
|
41625
|
+
* JSON string of the Teams adaptive card
|
|
41626
|
+
* @type {string}
|
|
41627
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41628
|
+
*/
|
|
41629
|
+
'messageJSON'?: string | null;
|
|
41630
|
+
/**
|
|
41631
|
+
* Whether this is a subscription notification
|
|
41632
|
+
* @type {boolean}
|
|
41633
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41634
|
+
*/
|
|
41635
|
+
'isSubscription'?: boolean | null;
|
|
41636
|
+
/**
|
|
41637
|
+
* The approval request ID
|
|
41638
|
+
* @type {string}
|
|
41639
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41640
|
+
*/
|
|
41641
|
+
'approvalId'?: string | null;
|
|
41642
|
+
/**
|
|
41643
|
+
* The request ID
|
|
41644
|
+
* @type {string}
|
|
41645
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41646
|
+
*/
|
|
41647
|
+
'requestId'?: string | null;
|
|
41648
|
+
/**
|
|
41649
|
+
* The ID of the user who made the request
|
|
41650
|
+
* @type {string}
|
|
41651
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41652
|
+
*/
|
|
41653
|
+
'requestedById'?: string | null;
|
|
41654
|
+
/**
|
|
41655
|
+
* The type of notification
|
|
41656
|
+
* @type {string}
|
|
41657
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41658
|
+
*/
|
|
41659
|
+
'notificationType'?: string | null;
|
|
41660
|
+
/**
|
|
41661
|
+
*
|
|
41662
|
+
* @type {TemplateSlackAutoApprovalDataV2024}
|
|
41663
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41664
|
+
*/
|
|
41665
|
+
'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null;
|
|
41666
|
+
/**
|
|
41667
|
+
*
|
|
41668
|
+
* @type {TemplateSlackCustomFieldsV2024}
|
|
41669
|
+
* @memberof TemplateDtoTeamsTemplateV2024
|
|
41670
|
+
*/
|
|
41671
|
+
'customFields'?: TemplateSlackCustomFieldsV2024 | null;
|
|
41672
|
+
}
|
|
41422
41673
|
/**
|
|
41423
41674
|
*
|
|
41424
41675
|
* @export
|
|
@@ -41513,21 +41764,19 @@ export interface TemplateDtoV2024 {
|
|
|
41513
41764
|
'modified'?: string;
|
|
41514
41765
|
/**
|
|
41515
41766
|
*
|
|
41516
|
-
* @type {
|
|
41767
|
+
* @type {TemplateDtoSlackTemplateV2024}
|
|
41517
41768
|
* @memberof TemplateDtoV2024
|
|
41518
41769
|
*/
|
|
41519
|
-
'slackTemplate'?:
|
|
41770
|
+
'slackTemplate'?: TemplateDtoSlackTemplateV2024;
|
|
41520
41771
|
/**
|
|
41521
41772
|
*
|
|
41522
|
-
* @type {
|
|
41773
|
+
* @type {TemplateDtoTeamsTemplateV2024}
|
|
41523
41774
|
* @memberof TemplateDtoV2024
|
|
41524
41775
|
*/
|
|
41525
|
-
'teamsTemplate'?:
|
|
41776
|
+
'teamsTemplate'?: TemplateDtoTeamsTemplateV2024;
|
|
41526
41777
|
}
|
|
41527
41778
|
export declare const TemplateDtoV2024MediumV2024: {
|
|
41528
41779
|
readonly Email: "EMAIL";
|
|
41529
|
-
readonly Phone: "PHONE";
|
|
41530
|
-
readonly Sms: "SMS";
|
|
41531
41780
|
readonly Slack: "SLACK";
|
|
41532
41781
|
readonly Teams: "TEAMS";
|
|
41533
41782
|
};
|
|
@@ -41539,31 +41788,31 @@ export type TemplateDtoV2024MediumV2024 = typeof TemplateDtoV2024MediumV2024[key
|
|
|
41539
41788
|
*/
|
|
41540
41789
|
export interface TemplateSlackAutoApprovalDataV2024 {
|
|
41541
41790
|
/**
|
|
41542
|
-
*
|
|
41791
|
+
* Whether the request was auto-approved
|
|
41543
41792
|
* @type {string}
|
|
41544
41793
|
* @memberof TemplateSlackAutoApprovalDataV2024
|
|
41545
41794
|
*/
|
|
41546
41795
|
'isAutoApproved'?: string | null;
|
|
41547
41796
|
/**
|
|
41548
|
-
*
|
|
41797
|
+
* The item ID
|
|
41549
41798
|
* @type {string}
|
|
41550
41799
|
* @memberof TemplateSlackAutoApprovalDataV2024
|
|
41551
41800
|
*/
|
|
41552
41801
|
'itemId'?: string | null;
|
|
41553
41802
|
/**
|
|
41554
|
-
*
|
|
41803
|
+
* The item type
|
|
41555
41804
|
* @type {string}
|
|
41556
41805
|
* @memberof TemplateSlackAutoApprovalDataV2024
|
|
41557
41806
|
*/
|
|
41558
41807
|
'itemType'?: string | null;
|
|
41559
41808
|
/**
|
|
41560
|
-
*
|
|
41809
|
+
* JSON message for auto-approval
|
|
41561
41810
|
* @type {string}
|
|
41562
41811
|
* @memberof TemplateSlackAutoApprovalDataV2024
|
|
41563
41812
|
*/
|
|
41564
41813
|
'autoApprovalMessageJSON'?: string | null;
|
|
41565
41814
|
/**
|
|
41566
|
-
*
|
|
41815
|
+
* Title for auto-approval
|
|
41567
41816
|
* @type {string}
|
|
41568
41817
|
* @memberof TemplateSlackAutoApprovalDataV2024
|
|
41569
41818
|
*/
|
|
@@ -41576,25 +41825,25 @@ export interface TemplateSlackAutoApprovalDataV2024 {
|
|
|
41576
41825
|
*/
|
|
41577
41826
|
export interface TemplateSlackCustomFieldsV2024 {
|
|
41578
41827
|
/**
|
|
41579
|
-
*
|
|
41828
|
+
* The type of request
|
|
41580
41829
|
* @type {string}
|
|
41581
41830
|
* @memberof TemplateSlackCustomFieldsV2024
|
|
41582
41831
|
*/
|
|
41583
41832
|
'requestType'?: string | null;
|
|
41584
41833
|
/**
|
|
41585
|
-
*
|
|
41834
|
+
* Whether the request contains a deny action
|
|
41586
41835
|
* @type {string}
|
|
41587
41836
|
* @memberof TemplateSlackCustomFieldsV2024
|
|
41588
41837
|
*/
|
|
41589
41838
|
'containsDeny'?: string | null;
|
|
41590
41839
|
/**
|
|
41591
|
-
*
|
|
41840
|
+
* The campaign ID
|
|
41592
41841
|
* @type {string}
|
|
41593
41842
|
* @memberof TemplateSlackCustomFieldsV2024
|
|
41594
41843
|
*/
|
|
41595
41844
|
'campaignId'?: string | null;
|
|
41596
41845
|
/**
|
|
41597
|
-
*
|
|
41846
|
+
* The campaign status
|
|
41598
41847
|
* @type {string}
|
|
41599
41848
|
* @memberof TemplateSlackCustomFieldsV2024
|
|
41600
41849
|
*/
|
|
@@ -41607,55 +41856,55 @@ export interface TemplateSlackCustomFieldsV2024 {
|
|
|
41607
41856
|
*/
|
|
41608
41857
|
export interface TemplateSlackV2024 {
|
|
41609
41858
|
/**
|
|
41610
|
-
*
|
|
41859
|
+
* The template key
|
|
41611
41860
|
* @type {string}
|
|
41612
41861
|
* @memberof TemplateSlackV2024
|
|
41613
41862
|
*/
|
|
41614
41863
|
'key'?: string | null;
|
|
41615
41864
|
/**
|
|
41616
|
-
*
|
|
41865
|
+
* The main text content of the Slack message
|
|
41617
41866
|
* @type {string}
|
|
41618
41867
|
* @memberof TemplateSlackV2024
|
|
41619
41868
|
*/
|
|
41620
41869
|
'text'?: string;
|
|
41621
41870
|
/**
|
|
41622
|
-
*
|
|
41871
|
+
* JSON string of Slack Block Kit blocks for rich formatting
|
|
41623
41872
|
* @type {string}
|
|
41624
41873
|
* @memberof TemplateSlackV2024
|
|
41625
41874
|
*/
|
|
41626
41875
|
'blocks'?: string | null;
|
|
41627
41876
|
/**
|
|
41628
|
-
*
|
|
41877
|
+
* JSON string of Slack attachments
|
|
41629
41878
|
* @type {string}
|
|
41630
41879
|
* @memberof TemplateSlackV2024
|
|
41631
41880
|
*/
|
|
41632
41881
|
'attachments'?: string;
|
|
41633
41882
|
/**
|
|
41634
|
-
*
|
|
41883
|
+
* The type of notification
|
|
41635
41884
|
* @type {string}
|
|
41636
41885
|
* @memberof TemplateSlackV2024
|
|
41637
41886
|
*/
|
|
41638
41887
|
'notificationType'?: string | null;
|
|
41639
41888
|
/**
|
|
41640
|
-
*
|
|
41889
|
+
* The approval request ID
|
|
41641
41890
|
* @type {string}
|
|
41642
41891
|
* @memberof TemplateSlackV2024
|
|
41643
41892
|
*/
|
|
41644
41893
|
'approvalId'?: string | null;
|
|
41645
41894
|
/**
|
|
41646
|
-
*
|
|
41895
|
+
* The request ID
|
|
41647
41896
|
* @type {string}
|
|
41648
41897
|
* @memberof TemplateSlackV2024
|
|
41649
41898
|
*/
|
|
41650
41899
|
'requestId'?: string | null;
|
|
41651
41900
|
/**
|
|
41652
|
-
*
|
|
41901
|
+
* The ID of the user who made the request
|
|
41653
41902
|
* @type {string}
|
|
41654
41903
|
* @memberof TemplateSlackV2024
|
|
41655
41904
|
*/
|
|
41656
41905
|
'requestedById'?: string | null;
|
|
41657
41906
|
/**
|
|
41658
|
-
*
|
|
41907
|
+
* Whether this is a subscription notification
|
|
41659
41908
|
* @type {boolean}
|
|
41660
41909
|
* @memberof TemplateSlackV2024
|
|
41661
41910
|
*/
|
|
@@ -41680,55 +41929,55 @@ export interface TemplateSlackV2024 {
|
|
|
41680
41929
|
*/
|
|
41681
41930
|
export interface TemplateTeamsV2024 {
|
|
41682
41931
|
/**
|
|
41683
|
-
*
|
|
41932
|
+
* The template key
|
|
41684
41933
|
* @type {string}
|
|
41685
41934
|
* @memberof TemplateTeamsV2024
|
|
41686
41935
|
*/
|
|
41687
41936
|
'key'?: string | null;
|
|
41688
41937
|
/**
|
|
41689
|
-
*
|
|
41938
|
+
* The title of the Teams message
|
|
41690
41939
|
* @type {string}
|
|
41691
41940
|
* @memberof TemplateTeamsV2024
|
|
41692
41941
|
*/
|
|
41693
41942
|
'title'?: string | null;
|
|
41694
41943
|
/**
|
|
41695
|
-
*
|
|
41944
|
+
* The main text content of the Teams message
|
|
41696
41945
|
* @type {string}
|
|
41697
41946
|
* @memberof TemplateTeamsV2024
|
|
41698
41947
|
*/
|
|
41699
41948
|
'text'?: string;
|
|
41700
41949
|
/**
|
|
41701
|
-
*
|
|
41950
|
+
* JSON string of the Teams adaptive card
|
|
41702
41951
|
* @type {string}
|
|
41703
41952
|
* @memberof TemplateTeamsV2024
|
|
41704
41953
|
*/
|
|
41705
41954
|
'messageJSON'?: string | null;
|
|
41706
41955
|
/**
|
|
41707
|
-
*
|
|
41956
|
+
* Whether this is a subscription notification
|
|
41708
41957
|
* @type {boolean}
|
|
41709
41958
|
* @memberof TemplateTeamsV2024
|
|
41710
41959
|
*/
|
|
41711
41960
|
'isSubscription'?: boolean | null;
|
|
41712
41961
|
/**
|
|
41713
|
-
*
|
|
41962
|
+
* The approval request ID
|
|
41714
41963
|
* @type {string}
|
|
41715
41964
|
* @memberof TemplateTeamsV2024
|
|
41716
41965
|
*/
|
|
41717
41966
|
'approvalId'?: string | null;
|
|
41718
41967
|
/**
|
|
41719
|
-
*
|
|
41968
|
+
* The request ID
|
|
41720
41969
|
* @type {string}
|
|
41721
41970
|
* @memberof TemplateTeamsV2024
|
|
41722
41971
|
*/
|
|
41723
41972
|
'requestId'?: string | null;
|
|
41724
41973
|
/**
|
|
41725
|
-
*
|
|
41974
|
+
* The ID of the user who made the request
|
|
41726
41975
|
* @type {string}
|
|
41727
41976
|
* @memberof TemplateTeamsV2024
|
|
41728
41977
|
*/
|
|
41729
41978
|
'requestedById'?: string | null;
|
|
41730
41979
|
/**
|
|
41731
|
-
*
|
|
41980
|
+
* The type of notification
|
|
41732
41981
|
* @type {string}
|
|
41733
41982
|
* @memberof TemplateTeamsV2024
|
|
41734
41983
|
*/
|
|
@@ -48161,22 +48410,22 @@ export declare const ApprovalsV2024ApiAxiosParamCreator: (configuration?: Config
|
|
|
48161
48410
|
* Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
|
|
48162
48411
|
* @summary Get an approval
|
|
48163
48412
|
* @param {string} id ID of the approval that is to be returned
|
|
48164
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48165
48413
|
* @param {*} [axiosOptions] Override http request option.
|
|
48166
48414
|
* @throws {RequiredError}
|
|
48167
48415
|
*/
|
|
48168
|
-
getApproval: (id: string,
|
|
48416
|
+
getApproval: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48169
48417
|
/**
|
|
48170
48418
|
* Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true.
|
|
48171
48419
|
* @summary Get approvals
|
|
48172
48420
|
* @param {boolean} [mine] Returns the list of approvals for the current caller
|
|
48173
48421
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID
|
|
48174
48422
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq*
|
|
48175
|
-
* @param {
|
|
48423
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48424
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48176
48425
|
* @param {*} [axiosOptions] Override http request option.
|
|
48177
48426
|
* @throws {RequiredError}
|
|
48178
48427
|
*/
|
|
48179
|
-
getApprovals: (mine?: boolean, requesterId?: string, filters?: string,
|
|
48428
|
+
getApprovals: (mine?: boolean, requesterId?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48180
48429
|
};
|
|
48181
48430
|
/**
|
|
48182
48431
|
* ApprovalsV2024Api - functional programming interface
|
|
@@ -48187,22 +48436,22 @@ export declare const ApprovalsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
48187
48436
|
* Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
|
|
48188
48437
|
* @summary Get an approval
|
|
48189
48438
|
* @param {string} id ID of the approval that is to be returned
|
|
48190
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48191
48439
|
* @param {*} [axiosOptions] Override http request option.
|
|
48192
48440
|
* @throws {RequiredError}
|
|
48193
48441
|
*/
|
|
48194
|
-
getApproval(id: string,
|
|
48442
|
+
getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2024>>;
|
|
48195
48443
|
/**
|
|
48196
48444
|
* Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true.
|
|
48197
48445
|
* @summary Get approvals
|
|
48198
48446
|
* @param {boolean} [mine] Returns the list of approvals for the current caller
|
|
48199
48447
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID
|
|
48200
48448
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq*
|
|
48201
|
-
* @param {
|
|
48449
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48450
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48202
48451
|
* @param {*} [axiosOptions] Override http request option.
|
|
48203
48452
|
* @throws {RequiredError}
|
|
48204
48453
|
*/
|
|
48205
|
-
getApprovals(mine?: boolean, requesterId?: string, filters?: string,
|
|
48454
|
+
getApprovals(mine?: boolean, requesterId?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2024>>>;
|
|
48206
48455
|
};
|
|
48207
48456
|
/**
|
|
48208
48457
|
* ApprovalsV2024Api - factory interface
|
|
@@ -48238,12 +48487,6 @@ export interface ApprovalsV2024ApiGetApprovalRequest {
|
|
|
48238
48487
|
* @memberof ApprovalsV2024ApiGetApproval
|
|
48239
48488
|
*/
|
|
48240
48489
|
readonly id: string;
|
|
48241
|
-
/**
|
|
48242
|
-
* Use this header to enable this experimental API.
|
|
48243
|
-
* @type {string}
|
|
48244
|
-
* @memberof ApprovalsV2024ApiGetApproval
|
|
48245
|
-
*/
|
|
48246
|
-
readonly xSailPointExperimental?: string;
|
|
48247
48490
|
}
|
|
48248
48491
|
/**
|
|
48249
48492
|
* Request parameters for getApprovals operation in ApprovalsV2024Api.
|
|
@@ -48270,11 +48513,17 @@ export interface ApprovalsV2024ApiGetApprovalsRequest {
|
|
|
48270
48513
|
*/
|
|
48271
48514
|
readonly filters?: string;
|
|
48272
48515
|
/**
|
|
48273
|
-
*
|
|
48274
|
-
* @type {
|
|
48516
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48517
|
+
* @type {number}
|
|
48275
48518
|
* @memberof ApprovalsV2024ApiGetApprovals
|
|
48276
48519
|
*/
|
|
48277
|
-
readonly
|
|
48520
|
+
readonly limit?: number;
|
|
48521
|
+
/**
|
|
48522
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
48523
|
+
* @type {number}
|
|
48524
|
+
* @memberof ApprovalsV2024ApiGetApprovals
|
|
48525
|
+
*/
|
|
48526
|
+
readonly offset?: number;
|
|
48278
48527
|
}
|
|
48279
48528
|
/**
|
|
48280
48529
|
* ApprovalsV2024Api - object-oriented interface
|
|
@@ -71495,113 +71744,103 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
71495
71744
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
71496
71745
|
* @summary Verify domain address via dkim
|
|
71497
71746
|
* @param {DomainAddressV2024} domainAddressV2024
|
|
71498
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71499
71747
|
* @param {*} [axiosOptions] Override http request option.
|
|
71500
71748
|
* @throws {RequiredError}
|
|
71501
71749
|
*/
|
|
71502
|
-
createDomainDkim: (domainAddressV2024: DomainAddressV2024,
|
|
71750
|
+
createDomainDkim: (domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71503
71751
|
/**
|
|
71504
71752
|
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
71505
71753
|
* @summary Create notification template
|
|
71506
71754
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
71507
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71508
71755
|
* @param {*} [axiosOptions] Override http request option.
|
|
71509
71756
|
* @throws {RequiredError}
|
|
71510
71757
|
*/
|
|
71511
|
-
createNotificationTemplate: (templateDtoV2024: TemplateDtoV2024,
|
|
71758
|
+
createNotificationTemplate: (templateDtoV2024: TemplateDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71512
71759
|
/**
|
|
71513
71760
|
* Create a new sender email address and initiate verification process.
|
|
71514
71761
|
* @summary Create verified from address
|
|
71515
71762
|
* @param {EmailStatusDtoV2024} emailStatusDtoV2024
|
|
71516
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71517
71763
|
* @param {*} [axiosOptions] Override http request option.
|
|
71518
71764
|
* @throws {RequiredError}
|
|
71519
71765
|
*/
|
|
71520
|
-
createVerifiedFromAddress: (emailStatusDtoV2024: EmailStatusDtoV2024,
|
|
71766
|
+
createVerifiedFromAddress: (emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71521
71767
|
/**
|
|
71522
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
71768
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
71523
71769
|
* @summary Bulk delete notification templates
|
|
71524
71770
|
* @param {Array<TemplateBulkDeleteDtoV2024>} templateBulkDeleteDtoV2024
|
|
71525
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71526
71771
|
* @param {*} [axiosOptions] Override http request option.
|
|
71527
71772
|
* @throws {RequiredError}
|
|
71528
71773
|
*/
|
|
71529
|
-
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>,
|
|
71774
|
+
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71530
71775
|
/**
|
|
71531
71776
|
* Delete a verified sender email address
|
|
71532
71777
|
* @summary Delete verified from address
|
|
71533
|
-
* @param {string} id
|
|
71534
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71778
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
71535
71779
|
* @param {*} [axiosOptions] Override http request option.
|
|
71536
71780
|
* @throws {RequiredError}
|
|
71537
71781
|
*/
|
|
71538
|
-
deleteVerifiedFromAddress: (id: string,
|
|
71782
|
+
deleteVerifiedFromAddress: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71539
71783
|
/**
|
|
71540
71784
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
71541
71785
|
* @summary Get dkim attributes
|
|
71542
|
-
* @param {
|
|
71786
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71787
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71543
71788
|
* @param {*} [axiosOptions] Override http request option.
|
|
71544
71789
|
* @throws {RequiredError}
|
|
71545
71790
|
*/
|
|
71546
|
-
getDkimAttributes: (
|
|
71791
|
+
getDkimAttributes: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71547
71792
|
/**
|
|
71548
71793
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
71549
71794
|
* @summary Get mail from attributes
|
|
71550
|
-
* @param {string}
|
|
71551
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71795
|
+
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
71552
71796
|
* @param {*} [axiosOptions] Override http request option.
|
|
71553
71797
|
* @throws {RequiredError}
|
|
71554
71798
|
*/
|
|
71555
|
-
getMailFromAttributes: (
|
|
71799
|
+
getMailFromAttributes: (identity: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71800
|
+
/**
|
|
71801
|
+
* Returns a list of notification preferences for tenant.
|
|
71802
|
+
* @summary List notification preferences for tenant.
|
|
71803
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
71804
|
+
* @throws {RequiredError}
|
|
71805
|
+
*/
|
|
71806
|
+
getNotificationPreferences: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71556
71807
|
/**
|
|
71557
71808
|
* This gets a template that you have modified for your site by Id.
|
|
71558
71809
|
* @summary Get notification template by id
|
|
71559
71810
|
* @param {string} id Id of the Notification Template
|
|
71560
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71561
71811
|
* @param {*} [axiosOptions] Override http request option.
|
|
71562
71812
|
* @throws {RequiredError}
|
|
71563
71813
|
*/
|
|
71564
|
-
getNotificationTemplate: (id: string,
|
|
71814
|
+
getNotificationTemplate: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71565
71815
|
/**
|
|
71566
71816
|
* The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization).
|
|
71567
71817
|
* @summary Get notification template context
|
|
71568
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71569
71818
|
* @param {*} [axiosOptions] Override http request option.
|
|
71570
71819
|
* @throws {RequiredError}
|
|
71571
71820
|
*/
|
|
71572
|
-
getNotificationsTemplateContext: (
|
|
71821
|
+
getNotificationsTemplateContext: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71573
71822
|
/**
|
|
71574
71823
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
71575
71824
|
* @summary List from addresses
|
|
71576
71825
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71577
71826
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71578
71827
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71579
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le,
|
|
71828
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt*
|
|
71580
71829
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email**
|
|
71581
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71582
71830
|
* @param {*} [axiosOptions] Override http request option.
|
|
71583
71831
|
* @throws {RequiredError}
|
|
71584
71832
|
*/
|
|
71585
|
-
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
71586
|
-
/**
|
|
71587
|
-
* Returns a list of notification preferences for tenant.
|
|
71588
|
-
* @summary List notification preferences for tenant.
|
|
71589
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71590
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
71591
|
-
* @throws {RequiredError}
|
|
71592
|
-
*/
|
|
71593
|
-
listNotificationPreferences: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71833
|
+
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71594
71834
|
/**
|
|
71595
71835
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
71596
71836
|
* @summary List notification template defaults
|
|
71597
71837
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71598
71838
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71599
71839
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
71600
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71601
71840
|
* @param {*} [axiosOptions] Override http request option.
|
|
71602
71841
|
* @throws {RequiredError}
|
|
71603
71842
|
*/
|
|
71604
|
-
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string,
|
|
71843
|
+
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71605
71844
|
/**
|
|
71606
71845
|
* This lists the templates that you have modified for your site.
|
|
71607
71846
|
* @summary List notification templates
|
|
@@ -71609,29 +71848,26 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
71609
71848
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71610
71849
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
71611
71850
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium**
|
|
71612
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71613
71851
|
* @param {*} [axiosOptions] Override http request option.
|
|
71614
71852
|
* @throws {RequiredError}
|
|
71615
71853
|
*/
|
|
71616
|
-
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string,
|
|
71854
|
+
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71617
71855
|
/**
|
|
71618
71856
|
* Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS
|
|
71619
71857
|
* @summary Change mail from domain
|
|
71620
71858
|
* @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024
|
|
71621
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71622
71859
|
* @param {*} [axiosOptions] Override http request option.
|
|
71623
71860
|
* @throws {RequiredError}
|
|
71624
71861
|
*/
|
|
71625
|
-
putMailFromAttributes: (mailFromAttributesDtoV2024: MailFromAttributesDtoV2024,
|
|
71862
|
+
putMailFromAttributes: (mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71626
71863
|
/**
|
|
71627
71864
|
* Send a Test Notification
|
|
71628
71865
|
* @summary Send test notification
|
|
71629
71866
|
* @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024
|
|
71630
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71631
71867
|
* @param {*} [axiosOptions] Override http request option.
|
|
71632
71868
|
* @throws {RequiredError}
|
|
71633
71869
|
*/
|
|
71634
|
-
sendTestNotification: (sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024,
|
|
71870
|
+
sendTestNotification: (sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71635
71871
|
};
|
|
71636
71872
|
/**
|
|
71637
71873
|
* NotificationsV2024Api - functional programming interface
|
|
@@ -71642,113 +71878,103 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
71642
71878
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
71643
71879
|
* @summary Verify domain address via dkim
|
|
71644
71880
|
* @param {DomainAddressV2024} domainAddressV2024
|
|
71645
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71646
71881
|
* @param {*} [axiosOptions] Override http request option.
|
|
71647
71882
|
* @throws {RequiredError}
|
|
71648
71883
|
*/
|
|
71649
|
-
createDomainDkim(domainAddressV2024: DomainAddressV2024,
|
|
71884
|
+
createDomainDkim(domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainStatusDtoV2024>>;
|
|
71650
71885
|
/**
|
|
71651
71886
|
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
71652
71887
|
* @summary Create notification template
|
|
71653
71888
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
71654
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71655
71889
|
* @param {*} [axiosOptions] Override http request option.
|
|
71656
71890
|
* @throws {RequiredError}
|
|
71657
71891
|
*/
|
|
71658
|
-
createNotificationTemplate(templateDtoV2024: TemplateDtoV2024,
|
|
71892
|
+
createNotificationTemplate(templateDtoV2024: TemplateDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2024>>;
|
|
71659
71893
|
/**
|
|
71660
71894
|
* Create a new sender email address and initiate verification process.
|
|
71661
71895
|
* @summary Create verified from address
|
|
71662
71896
|
* @param {EmailStatusDtoV2024} emailStatusDtoV2024
|
|
71663
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71664
71897
|
* @param {*} [axiosOptions] Override http request option.
|
|
71665
71898
|
* @throws {RequiredError}
|
|
71666
71899
|
*/
|
|
71667
|
-
createVerifiedFromAddress(emailStatusDtoV2024: EmailStatusDtoV2024,
|
|
71900
|
+
createVerifiedFromAddress(emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailStatusDtoV2024>>;
|
|
71668
71901
|
/**
|
|
71669
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
71902
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
71670
71903
|
* @summary Bulk delete notification templates
|
|
71671
71904
|
* @param {Array<TemplateBulkDeleteDtoV2024>} templateBulkDeleteDtoV2024
|
|
71672
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71673
71905
|
* @param {*} [axiosOptions] Override http request option.
|
|
71674
71906
|
* @throws {RequiredError}
|
|
71675
71907
|
*/
|
|
71676
|
-
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>,
|
|
71908
|
+
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71677
71909
|
/**
|
|
71678
71910
|
* Delete a verified sender email address
|
|
71679
71911
|
* @summary Delete verified from address
|
|
71680
|
-
* @param {string} id
|
|
71681
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71912
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
71682
71913
|
* @param {*} [axiosOptions] Override http request option.
|
|
71683
71914
|
* @throws {RequiredError}
|
|
71684
71915
|
*/
|
|
71685
|
-
deleteVerifiedFromAddress(id: string,
|
|
71916
|
+
deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71686
71917
|
/**
|
|
71687
71918
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
71688
71919
|
* @summary Get dkim attributes
|
|
71689
|
-
* @param {
|
|
71920
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71921
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71690
71922
|
* @param {*} [axiosOptions] Override http request option.
|
|
71691
71923
|
* @throws {RequiredError}
|
|
71692
71924
|
*/
|
|
71693
|
-
getDkimAttributes(
|
|
71925
|
+
getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DkimAttributesV2024>>>;
|
|
71694
71926
|
/**
|
|
71695
71927
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
71696
71928
|
* @summary Get mail from attributes
|
|
71697
|
-
* @param {string}
|
|
71698
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71929
|
+
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
71699
71930
|
* @param {*} [axiosOptions] Override http request option.
|
|
71700
71931
|
* @throws {RequiredError}
|
|
71701
71932
|
*/
|
|
71702
|
-
getMailFromAttributes(
|
|
71933
|
+
getMailFromAttributes(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MailFromAttributesV2024>>;
|
|
71934
|
+
/**
|
|
71935
|
+
* Returns a list of notification preferences for tenant.
|
|
71936
|
+
* @summary List notification preferences for tenant.
|
|
71937
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
71938
|
+
* @throws {RequiredError}
|
|
71939
|
+
*/
|
|
71940
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferencesDtoV2024>>;
|
|
71703
71941
|
/**
|
|
71704
71942
|
* This gets a template that you have modified for your site by Id.
|
|
71705
71943
|
* @summary Get notification template by id
|
|
71706
71944
|
* @param {string} id Id of the Notification Template
|
|
71707
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71708
71945
|
* @param {*} [axiosOptions] Override http request option.
|
|
71709
71946
|
* @throws {RequiredError}
|
|
71710
71947
|
*/
|
|
71711
|
-
getNotificationTemplate(id: string,
|
|
71948
|
+
getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2024>>;
|
|
71712
71949
|
/**
|
|
71713
71950
|
* The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization).
|
|
71714
71951
|
* @summary Get notification template context
|
|
71715
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71716
71952
|
* @param {*} [axiosOptions] Override http request option.
|
|
71717
71953
|
* @throws {RequiredError}
|
|
71718
71954
|
*/
|
|
71719
|
-
getNotificationsTemplateContext(
|
|
71955
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTemplateContextV2024>>;
|
|
71720
71956
|
/**
|
|
71721
71957
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
71722
71958
|
* @summary List from addresses
|
|
71723
71959
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71724
71960
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71725
71961
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71726
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le,
|
|
71962
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt*
|
|
71727
71963
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email**
|
|
71728
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71729
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
71730
|
-
* @throws {RequiredError}
|
|
71731
|
-
*/
|
|
71732
|
-
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailStatusDtoV2024>>>;
|
|
71733
|
-
/**
|
|
71734
|
-
* Returns a list of notification preferences for tenant.
|
|
71735
|
-
* @summary List notification preferences for tenant.
|
|
71736
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71737
71964
|
* @param {*} [axiosOptions] Override http request option.
|
|
71738
71965
|
* @throws {RequiredError}
|
|
71739
71966
|
*/
|
|
71740
|
-
|
|
71967
|
+
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailStatusDtoV2024>>>;
|
|
71741
71968
|
/**
|
|
71742
71969
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
71743
71970
|
* @summary List notification template defaults
|
|
71744
71971
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71745
71972
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71746
71973
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
71747
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71748
71974
|
* @param {*} [axiosOptions] Override http request option.
|
|
71749
71975
|
* @throws {RequiredError}
|
|
71750
71976
|
*/
|
|
71751
|
-
listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string,
|
|
71977
|
+
listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoDefaultV2024>>>;
|
|
71752
71978
|
/**
|
|
71753
71979
|
* This lists the templates that you have modified for your site.
|
|
71754
71980
|
* @summary List notification templates
|
|
@@ -71756,29 +71982,26 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
71756
71982
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
71757
71983
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
71758
71984
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium**
|
|
71759
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71760
71985
|
* @param {*} [axiosOptions] Override http request option.
|
|
71761
71986
|
* @throws {RequiredError}
|
|
71762
71987
|
*/
|
|
71763
|
-
listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string,
|
|
71988
|
+
listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoV2024>>>;
|
|
71764
71989
|
/**
|
|
71765
71990
|
* Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS
|
|
71766
71991
|
* @summary Change mail from domain
|
|
71767
71992
|
* @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024
|
|
71768
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71769
71993
|
* @param {*} [axiosOptions] Override http request option.
|
|
71770
71994
|
* @throws {RequiredError}
|
|
71771
71995
|
*/
|
|
71772
|
-
putMailFromAttributes(mailFromAttributesDtoV2024: MailFromAttributesDtoV2024,
|
|
71996
|
+
putMailFromAttributes(mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MailFromAttributesV2024>>;
|
|
71773
71997
|
/**
|
|
71774
71998
|
* Send a Test Notification
|
|
71775
71999
|
* @summary Send test notification
|
|
71776
72000
|
* @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024
|
|
71777
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71778
72001
|
* @param {*} [axiosOptions] Override http request option.
|
|
71779
72002
|
* @throws {RequiredError}
|
|
71780
72003
|
*/
|
|
71781
|
-
sendTestNotification(sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024,
|
|
72004
|
+
sendTestNotification(sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71782
72005
|
};
|
|
71783
72006
|
/**
|
|
71784
72007
|
* NotificationsV2024Api - factory interface
|
|
@@ -71810,7 +72033,7 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
71810
72033
|
*/
|
|
71811
72034
|
createVerifiedFromAddress(requestParameters: NotificationsV2024ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EmailStatusDtoV2024>;
|
|
71812
72035
|
/**
|
|
71813
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
72036
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
71814
72037
|
* @summary Bulk delete notification templates
|
|
71815
72038
|
* @param {NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters.
|
|
71816
72039
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -71841,6 +72064,13 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
71841
72064
|
* @throws {RequiredError}
|
|
71842
72065
|
*/
|
|
71843
72066
|
getMailFromAttributes(requestParameters: NotificationsV2024ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MailFromAttributesV2024>;
|
|
72067
|
+
/**
|
|
72068
|
+
* Returns a list of notification preferences for tenant.
|
|
72069
|
+
* @summary List notification preferences for tenant.
|
|
72070
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
72071
|
+
* @throws {RequiredError}
|
|
72072
|
+
*/
|
|
72073
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PreferencesDtoV2024>;
|
|
71844
72074
|
/**
|
|
71845
72075
|
* This gets a template that you have modified for your site by Id.
|
|
71846
72076
|
* @summary Get notification template by id
|
|
@@ -71852,11 +72082,10 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
71852
72082
|
/**
|
|
71853
72083
|
* The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization).
|
|
71854
72084
|
* @summary Get notification template context
|
|
71855
|
-
* @param {NotificationsV2024ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
71856
72085
|
* @param {*} [axiosOptions] Override http request option.
|
|
71857
72086
|
* @throws {RequiredError}
|
|
71858
72087
|
*/
|
|
71859
|
-
getNotificationsTemplateContext(
|
|
72088
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<NotificationTemplateContextV2024>;
|
|
71860
72089
|
/**
|
|
71861
72090
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
71862
72091
|
* @summary List from addresses
|
|
@@ -71865,14 +72094,6 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
71865
72094
|
* @throws {RequiredError}
|
|
71866
72095
|
*/
|
|
71867
72096
|
listFromAddresses(requestParameters?: NotificationsV2024ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EmailStatusDtoV2024>>;
|
|
71868
|
-
/**
|
|
71869
|
-
* Returns a list of notification preferences for tenant.
|
|
71870
|
-
* @summary List notification preferences for tenant.
|
|
71871
|
-
* @param {NotificationsV2024ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
71872
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
71873
|
-
* @throws {RequiredError}
|
|
71874
|
-
*/
|
|
71875
|
-
listNotificationPreferences(requestParameters?: NotificationsV2024ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PreferencesDtoV2024>;
|
|
71876
72097
|
/**
|
|
71877
72098
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
71878
72099
|
* @summary List notification template defaults
|
|
@@ -71918,12 +72139,6 @@ export interface NotificationsV2024ApiCreateDomainDkimRequest {
|
|
|
71918
72139
|
* @memberof NotificationsV2024ApiCreateDomainDkim
|
|
71919
72140
|
*/
|
|
71920
72141
|
readonly domainAddressV2024: DomainAddressV2024;
|
|
71921
|
-
/**
|
|
71922
|
-
* Use this header to enable this experimental API.
|
|
71923
|
-
* @type {string}
|
|
71924
|
-
* @memberof NotificationsV2024ApiCreateDomainDkim
|
|
71925
|
-
*/
|
|
71926
|
-
readonly xSailPointExperimental?: string;
|
|
71927
72142
|
}
|
|
71928
72143
|
/**
|
|
71929
72144
|
* Request parameters for createNotificationTemplate operation in NotificationsV2024Api.
|
|
@@ -71937,12 +72152,6 @@ export interface NotificationsV2024ApiCreateNotificationTemplateRequest {
|
|
|
71937
72152
|
* @memberof NotificationsV2024ApiCreateNotificationTemplate
|
|
71938
72153
|
*/
|
|
71939
72154
|
readonly templateDtoV2024: TemplateDtoV2024;
|
|
71940
|
-
/**
|
|
71941
|
-
* Use this header to enable this experimental API.
|
|
71942
|
-
* @type {string}
|
|
71943
|
-
* @memberof NotificationsV2024ApiCreateNotificationTemplate
|
|
71944
|
-
*/
|
|
71945
|
-
readonly xSailPointExperimental?: string;
|
|
71946
72155
|
}
|
|
71947
72156
|
/**
|
|
71948
72157
|
* Request parameters for createVerifiedFromAddress operation in NotificationsV2024Api.
|
|
@@ -71956,12 +72165,6 @@ export interface NotificationsV2024ApiCreateVerifiedFromAddressRequest {
|
|
|
71956
72165
|
* @memberof NotificationsV2024ApiCreateVerifiedFromAddress
|
|
71957
72166
|
*/
|
|
71958
72167
|
readonly emailStatusDtoV2024: EmailStatusDtoV2024;
|
|
71959
|
-
/**
|
|
71960
|
-
* Use this header to enable this experimental API.
|
|
71961
|
-
* @type {string}
|
|
71962
|
-
* @memberof NotificationsV2024ApiCreateVerifiedFromAddress
|
|
71963
|
-
*/
|
|
71964
|
-
readonly xSailPointExperimental?: string;
|
|
71965
72168
|
}
|
|
71966
72169
|
/**
|
|
71967
72170
|
* Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2024Api.
|
|
@@ -71975,12 +72178,6 @@ export interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
71975
72178
|
* @memberof NotificationsV2024ApiDeleteNotificationTemplatesInBulk
|
|
71976
72179
|
*/
|
|
71977
72180
|
readonly templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>;
|
|
71978
|
-
/**
|
|
71979
|
-
* Use this header to enable this experimental API.
|
|
71980
|
-
* @type {string}
|
|
71981
|
-
* @memberof NotificationsV2024ApiDeleteNotificationTemplatesInBulk
|
|
71982
|
-
*/
|
|
71983
|
-
readonly xSailPointExperimental?: string;
|
|
71984
72181
|
}
|
|
71985
72182
|
/**
|
|
71986
72183
|
* Request parameters for deleteVerifiedFromAddress operation in NotificationsV2024Api.
|
|
@@ -71989,17 +72186,11 @@ export interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
71989
72186
|
*/
|
|
71990
72187
|
export interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest {
|
|
71991
72188
|
/**
|
|
71992
|
-
*
|
|
72189
|
+
* Unique identifier of the verified sender address to delete.
|
|
71993
72190
|
* @type {string}
|
|
71994
72191
|
* @memberof NotificationsV2024ApiDeleteVerifiedFromAddress
|
|
71995
72192
|
*/
|
|
71996
72193
|
readonly id: string;
|
|
71997
|
-
/**
|
|
71998
|
-
* Use this header to enable this experimental API.
|
|
71999
|
-
* @type {string}
|
|
72000
|
-
* @memberof NotificationsV2024ApiDeleteVerifiedFromAddress
|
|
72001
|
-
*/
|
|
72002
|
-
readonly xSailPointExperimental?: string;
|
|
72003
72194
|
}
|
|
72004
72195
|
/**
|
|
72005
72196
|
* Request parameters for getDkimAttributes operation in NotificationsV2024Api.
|
|
@@ -72008,11 +72199,17 @@ export interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest {
|
|
|
72008
72199
|
*/
|
|
72009
72200
|
export interface NotificationsV2024ApiGetDkimAttributesRequest {
|
|
72010
72201
|
/**
|
|
72011
|
-
*
|
|
72012
|
-
* @type {
|
|
72202
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
72203
|
+
* @type {number}
|
|
72013
72204
|
* @memberof NotificationsV2024ApiGetDkimAttributes
|
|
72014
72205
|
*/
|
|
72015
|
-
readonly
|
|
72206
|
+
readonly limit?: number;
|
|
72207
|
+
/**
|
|
72208
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
72209
|
+
* @type {number}
|
|
72210
|
+
* @memberof NotificationsV2024ApiGetDkimAttributes
|
|
72211
|
+
*/
|
|
72212
|
+
readonly offset?: number;
|
|
72016
72213
|
}
|
|
72017
72214
|
/**
|
|
72018
72215
|
* Request parameters for getMailFromAttributes operation in NotificationsV2024Api.
|
|
@@ -72025,13 +72222,7 @@ export interface NotificationsV2024ApiGetMailFromAttributesRequest {
|
|
|
72025
72222
|
* @type {string}
|
|
72026
72223
|
* @memberof NotificationsV2024ApiGetMailFromAttributes
|
|
72027
72224
|
*/
|
|
72028
|
-
readonly
|
|
72029
|
-
/**
|
|
72030
|
-
* Use this header to enable this experimental API.
|
|
72031
|
-
* @type {string}
|
|
72032
|
-
* @memberof NotificationsV2024ApiGetMailFromAttributes
|
|
72033
|
-
*/
|
|
72034
|
-
readonly xSailPointExperimental?: string;
|
|
72225
|
+
readonly identity: string;
|
|
72035
72226
|
}
|
|
72036
72227
|
/**
|
|
72037
72228
|
* Request parameters for getNotificationTemplate operation in NotificationsV2024Api.
|
|
@@ -72045,25 +72236,6 @@ export interface NotificationsV2024ApiGetNotificationTemplateRequest {
|
|
|
72045
72236
|
* @memberof NotificationsV2024ApiGetNotificationTemplate
|
|
72046
72237
|
*/
|
|
72047
72238
|
readonly id: string;
|
|
72048
|
-
/**
|
|
72049
|
-
* Use this header to enable this experimental API.
|
|
72050
|
-
* @type {string}
|
|
72051
|
-
* @memberof NotificationsV2024ApiGetNotificationTemplate
|
|
72052
|
-
*/
|
|
72053
|
-
readonly xSailPointExperimental?: string;
|
|
72054
|
-
}
|
|
72055
|
-
/**
|
|
72056
|
-
* Request parameters for getNotificationsTemplateContext operation in NotificationsV2024Api.
|
|
72057
|
-
* @export
|
|
72058
|
-
* @interface NotificationsV2024ApiGetNotificationsTemplateContextRequest
|
|
72059
|
-
*/
|
|
72060
|
-
export interface NotificationsV2024ApiGetNotificationsTemplateContextRequest {
|
|
72061
|
-
/**
|
|
72062
|
-
* Use this header to enable this experimental API.
|
|
72063
|
-
* @type {string}
|
|
72064
|
-
* @memberof NotificationsV2024ApiGetNotificationsTemplateContext
|
|
72065
|
-
*/
|
|
72066
|
-
readonly xSailPointExperimental?: string;
|
|
72067
72239
|
}
|
|
72068
72240
|
/**
|
|
72069
72241
|
* Request parameters for listFromAddresses operation in NotificationsV2024Api.
|
|
@@ -72090,7 +72262,7 @@ export interface NotificationsV2024ApiListFromAddressesRequest {
|
|
|
72090
72262
|
*/
|
|
72091
72263
|
readonly count?: boolean;
|
|
72092
72264
|
/**
|
|
72093
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le,
|
|
72265
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt*
|
|
72094
72266
|
* @type {string}
|
|
72095
72267
|
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72096
72268
|
*/
|
|
@@ -72101,25 +72273,6 @@ export interface NotificationsV2024ApiListFromAddressesRequest {
|
|
|
72101
72273
|
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72102
72274
|
*/
|
|
72103
72275
|
readonly sorters?: string;
|
|
72104
|
-
/**
|
|
72105
|
-
* Use this header to enable this experimental API.
|
|
72106
|
-
* @type {string}
|
|
72107
|
-
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72108
|
-
*/
|
|
72109
|
-
readonly xSailPointExperimental?: string;
|
|
72110
|
-
}
|
|
72111
|
-
/**
|
|
72112
|
-
* Request parameters for listNotificationPreferences operation in NotificationsV2024Api.
|
|
72113
|
-
* @export
|
|
72114
|
-
* @interface NotificationsV2024ApiListNotificationPreferencesRequest
|
|
72115
|
-
*/
|
|
72116
|
-
export interface NotificationsV2024ApiListNotificationPreferencesRequest {
|
|
72117
|
-
/**
|
|
72118
|
-
* Use this header to enable this experimental API.
|
|
72119
|
-
* @type {string}
|
|
72120
|
-
* @memberof NotificationsV2024ApiListNotificationPreferences
|
|
72121
|
-
*/
|
|
72122
|
-
readonly xSailPointExperimental?: string;
|
|
72123
72276
|
}
|
|
72124
72277
|
/**
|
|
72125
72278
|
* Request parameters for listNotificationTemplateDefaults operation in NotificationsV2024Api.
|
|
@@ -72145,12 +72298,6 @@ export interface NotificationsV2024ApiListNotificationTemplateDefaultsRequest {
|
|
|
72145
72298
|
* @memberof NotificationsV2024ApiListNotificationTemplateDefaults
|
|
72146
72299
|
*/
|
|
72147
72300
|
readonly filters?: string;
|
|
72148
|
-
/**
|
|
72149
|
-
* Use this header to enable this experimental API.
|
|
72150
|
-
* @type {string}
|
|
72151
|
-
* @memberof NotificationsV2024ApiListNotificationTemplateDefaults
|
|
72152
|
-
*/
|
|
72153
|
-
readonly xSailPointExperimental?: string;
|
|
72154
72301
|
}
|
|
72155
72302
|
/**
|
|
72156
72303
|
* Request parameters for listNotificationTemplates operation in NotificationsV2024Api.
|
|
@@ -72182,12 +72329,6 @@ export interface NotificationsV2024ApiListNotificationTemplatesRequest {
|
|
|
72182
72329
|
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
72183
72330
|
*/
|
|
72184
72331
|
readonly sorters?: string;
|
|
72185
|
-
/**
|
|
72186
|
-
* Use this header to enable this experimental API.
|
|
72187
|
-
* @type {string}
|
|
72188
|
-
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
72189
|
-
*/
|
|
72190
|
-
readonly xSailPointExperimental?: string;
|
|
72191
72332
|
}
|
|
72192
72333
|
/**
|
|
72193
72334
|
* Request parameters for putMailFromAttributes operation in NotificationsV2024Api.
|
|
@@ -72201,12 +72342,6 @@ export interface NotificationsV2024ApiPutMailFromAttributesRequest {
|
|
|
72201
72342
|
* @memberof NotificationsV2024ApiPutMailFromAttributes
|
|
72202
72343
|
*/
|
|
72203
72344
|
readonly mailFromAttributesDtoV2024: MailFromAttributesDtoV2024;
|
|
72204
|
-
/**
|
|
72205
|
-
* Use this header to enable this experimental API.
|
|
72206
|
-
* @type {string}
|
|
72207
|
-
* @memberof NotificationsV2024ApiPutMailFromAttributes
|
|
72208
|
-
*/
|
|
72209
|
-
readonly xSailPointExperimental?: string;
|
|
72210
72345
|
}
|
|
72211
72346
|
/**
|
|
72212
72347
|
* Request parameters for sendTestNotification operation in NotificationsV2024Api.
|
|
@@ -72220,12 +72355,6 @@ export interface NotificationsV2024ApiSendTestNotificationRequest {
|
|
|
72220
72355
|
* @memberof NotificationsV2024ApiSendTestNotification
|
|
72221
72356
|
*/
|
|
72222
72357
|
readonly sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024;
|
|
72223
|
-
/**
|
|
72224
|
-
* Use this header to enable this experimental API.
|
|
72225
|
-
* @type {string}
|
|
72226
|
-
* @memberof NotificationsV2024ApiSendTestNotification
|
|
72227
|
-
*/
|
|
72228
|
-
readonly xSailPointExperimental?: string;
|
|
72229
72358
|
}
|
|
72230
72359
|
/**
|
|
72231
72360
|
* NotificationsV2024Api - object-oriented interface
|
|
@@ -72262,7 +72391,7 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72262
72391
|
*/
|
|
72263
72392
|
createVerifiedFromAddress(requestParameters: NotificationsV2024ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailStatusDtoV2024, any>>;
|
|
72264
72393
|
/**
|
|
72265
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
72394
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
72266
72395
|
* @summary Bulk delete notification templates
|
|
72267
72396
|
* @param {NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters.
|
|
72268
72397
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -72297,6 +72426,14 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72297
72426
|
* @memberof NotificationsV2024Api
|
|
72298
72427
|
*/
|
|
72299
72428
|
getMailFromAttributes(requestParameters: NotificationsV2024ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MailFromAttributesV2024, any>>;
|
|
72429
|
+
/**
|
|
72430
|
+
* Returns a list of notification preferences for tenant.
|
|
72431
|
+
* @summary List notification preferences for tenant.
|
|
72432
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
72433
|
+
* @throws {RequiredError}
|
|
72434
|
+
* @memberof NotificationsV2024Api
|
|
72435
|
+
*/
|
|
72436
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferencesDtoV2024, any>>;
|
|
72300
72437
|
/**
|
|
72301
72438
|
* This gets a template that you have modified for your site by Id.
|
|
72302
72439
|
* @summary Get notification template by id
|
|
@@ -72309,12 +72446,11 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72309
72446
|
/**
|
|
72310
72447
|
* The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization).
|
|
72311
72448
|
* @summary Get notification template context
|
|
72312
|
-
* @param {NotificationsV2024ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
72313
72449
|
* @param {*} [axiosOptions] Override http request option.
|
|
72314
72450
|
* @throws {RequiredError}
|
|
72315
72451
|
* @memberof NotificationsV2024Api
|
|
72316
72452
|
*/
|
|
72317
|
-
getNotificationsTemplateContext(
|
|
72453
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationTemplateContextV2024, any>>;
|
|
72318
72454
|
/**
|
|
72319
72455
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
72320
72456
|
* @summary List from addresses
|
|
@@ -72324,15 +72460,6 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72324
72460
|
* @memberof NotificationsV2024Api
|
|
72325
72461
|
*/
|
|
72326
72462
|
listFromAddresses(requestParameters?: NotificationsV2024ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailStatusDtoV2024[], any>>;
|
|
72327
|
-
/**
|
|
72328
|
-
* Returns a list of notification preferences for tenant.
|
|
72329
|
-
* @summary List notification preferences for tenant.
|
|
72330
|
-
* @param {NotificationsV2024ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
72331
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
72332
|
-
* @throws {RequiredError}
|
|
72333
|
-
* @memberof NotificationsV2024Api
|
|
72334
|
-
*/
|
|
72335
|
-
listNotificationPreferences(requestParameters?: NotificationsV2024ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferencesDtoV2024, any>>;
|
|
72336
72463
|
/**
|
|
72337
72464
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
72338
72465
|
* @summary List notification template defaults
|