sailpoint-api-client 1.8.4 → 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 +73 -1
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +67 -1
- package/dist/beta/api.js +22 -12
- 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 +162 -218
- package/dist/v2024/api.js +213 -327
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.d.ts +157 -215
- package/dist/v2025/api.js +200 -316
- 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 +284 -450
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +268 -437
- 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
|
@@ -14240,7 +14240,7 @@ export interface EmailStatusDtoV2024 {
|
|
|
14240
14240
|
* @type {string}
|
|
14241
14241
|
* @memberof EmailStatusDtoV2024
|
|
14242
14242
|
*/
|
|
14243
|
-
'region'?: string;
|
|
14243
|
+
'region'?: string | null;
|
|
14244
14244
|
}
|
|
14245
14245
|
export declare const EmailStatusDtoV2024VerificationStatusV2024: {
|
|
14246
14246
|
readonly Pending: "PENDING";
|
|
@@ -15011,6 +15011,12 @@ export interface EntitlementV2024 {
|
|
|
15011
15011
|
* @memberof EntitlementV2024
|
|
15012
15012
|
*/
|
|
15013
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;
|
|
15014
15020
|
/**
|
|
15015
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.
|
|
15016
15022
|
* @type {{ [key: string]: any; }}
|
|
@@ -17230,7 +17236,37 @@ export interface FullDiscoveredApplicationsV2024 {
|
|
|
17230
17236
|
* @memberof FullDiscoveredApplicationsV2024
|
|
17231
17237
|
*/
|
|
17232
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;
|
|
17233
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];
|
|
17234
17270
|
/**
|
|
17235
17271
|
*
|
|
17236
17272
|
* @export
|
|
@@ -37516,7 +37552,37 @@ export interface SlimDiscoveredApplicationsV2024 {
|
|
|
37516
37552
|
* @memberof SlimDiscoveredApplicationsV2024
|
|
37517
37553
|
*/
|
|
37518
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;
|
|
37519
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];
|
|
37520
37586
|
/**
|
|
37521
37587
|
* Details of the Entitlement criteria
|
|
37522
37588
|
* @export
|
|
@@ -48344,22 +48410,22 @@ export declare const ApprovalsV2024ApiAxiosParamCreator: (configuration?: Config
|
|
|
48344
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.
|
|
48345
48411
|
* @summary Get an approval
|
|
48346
48412
|
* @param {string} id ID of the approval that is to be returned
|
|
48347
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48348
48413
|
* @param {*} [axiosOptions] Override http request option.
|
|
48349
48414
|
* @throws {RequiredError}
|
|
48350
48415
|
*/
|
|
48351
|
-
getApproval: (id: string,
|
|
48416
|
+
getApproval: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48352
48417
|
/**
|
|
48353
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.
|
|
48354
48419
|
* @summary Get approvals
|
|
48355
48420
|
* @param {boolean} [mine] Returns the list of approvals for the current caller
|
|
48356
48421
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID
|
|
48357
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*
|
|
48358
|
-
* @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.
|
|
48359
48425
|
* @param {*} [axiosOptions] Override http request option.
|
|
48360
48426
|
* @throws {RequiredError}
|
|
48361
48427
|
*/
|
|
48362
|
-
getApprovals: (mine?: boolean, requesterId?: string, filters?: string,
|
|
48428
|
+
getApprovals: (mine?: boolean, requesterId?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48363
48429
|
};
|
|
48364
48430
|
/**
|
|
48365
48431
|
* ApprovalsV2024Api - functional programming interface
|
|
@@ -48370,22 +48436,22 @@ export declare const ApprovalsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
48370
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.
|
|
48371
48437
|
* @summary Get an approval
|
|
48372
48438
|
* @param {string} id ID of the approval that is to be returned
|
|
48373
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48374
48439
|
* @param {*} [axiosOptions] Override http request option.
|
|
48375
48440
|
* @throws {RequiredError}
|
|
48376
48441
|
*/
|
|
48377
|
-
getApproval(id: string,
|
|
48442
|
+
getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2024>>;
|
|
48378
48443
|
/**
|
|
48379
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.
|
|
48380
48445
|
* @summary Get approvals
|
|
48381
48446
|
* @param {boolean} [mine] Returns the list of approvals for the current caller
|
|
48382
48447
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID
|
|
48383
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*
|
|
48384
|
-
* @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.
|
|
48385
48451
|
* @param {*} [axiosOptions] Override http request option.
|
|
48386
48452
|
* @throws {RequiredError}
|
|
48387
48453
|
*/
|
|
48388
|
-
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>>>;
|
|
48389
48455
|
};
|
|
48390
48456
|
/**
|
|
48391
48457
|
* ApprovalsV2024Api - factory interface
|
|
@@ -48421,12 +48487,6 @@ export interface ApprovalsV2024ApiGetApprovalRequest {
|
|
|
48421
48487
|
* @memberof ApprovalsV2024ApiGetApproval
|
|
48422
48488
|
*/
|
|
48423
48489
|
readonly id: string;
|
|
48424
|
-
/**
|
|
48425
|
-
* Use this header to enable this experimental API.
|
|
48426
|
-
* @type {string}
|
|
48427
|
-
* @memberof ApprovalsV2024ApiGetApproval
|
|
48428
|
-
*/
|
|
48429
|
-
readonly xSailPointExperimental?: string;
|
|
48430
48490
|
}
|
|
48431
48491
|
/**
|
|
48432
48492
|
* Request parameters for getApprovals operation in ApprovalsV2024Api.
|
|
@@ -48453,11 +48513,17 @@ export interface ApprovalsV2024ApiGetApprovalsRequest {
|
|
|
48453
48513
|
*/
|
|
48454
48514
|
readonly filters?: string;
|
|
48455
48515
|
/**
|
|
48456
|
-
*
|
|
48457
|
-
* @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}
|
|
48458
48518
|
* @memberof ApprovalsV2024ApiGetApprovals
|
|
48459
48519
|
*/
|
|
48460
|
-
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;
|
|
48461
48527
|
}
|
|
48462
48528
|
/**
|
|
48463
48529
|
* ApprovalsV2024Api - object-oriented interface
|
|
@@ -71678,113 +71744,103 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
71678
71744
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
71679
71745
|
* @summary Verify domain address via dkim
|
|
71680
71746
|
* @param {DomainAddressV2024} domainAddressV2024
|
|
71681
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71682
71747
|
* @param {*} [axiosOptions] Override http request option.
|
|
71683
71748
|
* @throws {RequiredError}
|
|
71684
71749
|
*/
|
|
71685
|
-
createDomainDkim: (domainAddressV2024: DomainAddressV2024,
|
|
71750
|
+
createDomainDkim: (domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71686
71751
|
/**
|
|
71687
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.
|
|
71688
71753
|
* @summary Create notification template
|
|
71689
71754
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
71690
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71691
71755
|
* @param {*} [axiosOptions] Override http request option.
|
|
71692
71756
|
* @throws {RequiredError}
|
|
71693
71757
|
*/
|
|
71694
|
-
createNotificationTemplate: (templateDtoV2024: TemplateDtoV2024,
|
|
71758
|
+
createNotificationTemplate: (templateDtoV2024: TemplateDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71695
71759
|
/**
|
|
71696
71760
|
* Create a new sender email address and initiate verification process.
|
|
71697
71761
|
* @summary Create verified from address
|
|
71698
71762
|
* @param {EmailStatusDtoV2024} emailStatusDtoV2024
|
|
71699
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71700
71763
|
* @param {*} [axiosOptions] Override http request option.
|
|
71701
71764
|
* @throws {RequiredError}
|
|
71702
71765
|
*/
|
|
71703
|
-
createVerifiedFromAddress: (emailStatusDtoV2024: EmailStatusDtoV2024,
|
|
71766
|
+
createVerifiedFromAddress: (emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71704
71767
|
/**
|
|
71705
71768
|
* This lets you bulk delete templates that you previously created for your site.
|
|
71706
71769
|
* @summary Bulk delete notification templates
|
|
71707
71770
|
* @param {Array<TemplateBulkDeleteDtoV2024>} templateBulkDeleteDtoV2024
|
|
71708
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71709
71771
|
* @param {*} [axiosOptions] Override http request option.
|
|
71710
71772
|
* @throws {RequiredError}
|
|
71711
71773
|
*/
|
|
71712
|
-
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>,
|
|
71774
|
+
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71713
71775
|
/**
|
|
71714
71776
|
* Delete a verified sender email address
|
|
71715
71777
|
* @summary Delete verified from address
|
|
71716
|
-
* @param {string} id
|
|
71717
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71778
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
71718
71779
|
* @param {*} [axiosOptions] Override http request option.
|
|
71719
71780
|
* @throws {RequiredError}
|
|
71720
71781
|
*/
|
|
71721
|
-
deleteVerifiedFromAddress: (id: string,
|
|
71782
|
+
deleteVerifiedFromAddress: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71722
71783
|
/**
|
|
71723
71784
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
71724
71785
|
* @summary Get dkim attributes
|
|
71725
|
-
* @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.
|
|
71726
71788
|
* @param {*} [axiosOptions] Override http request option.
|
|
71727
71789
|
* @throws {RequiredError}
|
|
71728
71790
|
*/
|
|
71729
|
-
getDkimAttributes: (
|
|
71791
|
+
getDkimAttributes: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71730
71792
|
/**
|
|
71731
71793
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
71732
71794
|
* @summary Get mail from attributes
|
|
71733
71795
|
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
71734
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71735
71796
|
* @param {*} [axiosOptions] Override http request option.
|
|
71736
71797
|
* @throws {RequiredError}
|
|
71737
71798
|
*/
|
|
71738
|
-
getMailFromAttributes: (identity: string,
|
|
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>;
|
|
71739
71807
|
/**
|
|
71740
71808
|
* This gets a template that you have modified for your site by Id.
|
|
71741
71809
|
* @summary Get notification template by id
|
|
71742
71810
|
* @param {string} id Id of the Notification Template
|
|
71743
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71744
71811
|
* @param {*} [axiosOptions] Override http request option.
|
|
71745
71812
|
* @throws {RequiredError}
|
|
71746
71813
|
*/
|
|
71747
|
-
getNotificationTemplate: (id: string,
|
|
71814
|
+
getNotificationTemplate: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71748
71815
|
/**
|
|
71749
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).
|
|
71750
71817
|
* @summary Get notification template context
|
|
71751
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71752
71818
|
* @param {*} [axiosOptions] Override http request option.
|
|
71753
71819
|
* @throws {RequiredError}
|
|
71754
71820
|
*/
|
|
71755
|
-
getNotificationsTemplateContext: (
|
|
71821
|
+
getNotificationsTemplateContext: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71756
71822
|
/**
|
|
71757
71823
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
71758
71824
|
* @summary List from addresses
|
|
71759
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.
|
|
71760
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.
|
|
71761
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.
|
|
71762
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
71763
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**
|
|
71764
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71765
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
71766
|
-
* @throws {RequiredError}
|
|
71767
|
-
*/
|
|
71768
|
-
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71769
|
-
/**
|
|
71770
|
-
* Returns a list of notification preferences for tenant.
|
|
71771
|
-
* @summary List notification preferences for tenant.
|
|
71772
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71773
71830
|
* @param {*} [axiosOptions] Override http request option.
|
|
71774
71831
|
* @throws {RequiredError}
|
|
71775
71832
|
*/
|
|
71776
|
-
|
|
71833
|
+
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71777
71834
|
/**
|
|
71778
71835
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
71779
71836
|
* @summary List notification template defaults
|
|
71780
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.
|
|
71781
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.
|
|
71782
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*
|
|
71783
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71784
71840
|
* @param {*} [axiosOptions] Override http request option.
|
|
71785
71841
|
* @throws {RequiredError}
|
|
71786
71842
|
*/
|
|
71787
|
-
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string,
|
|
71843
|
+
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71788
71844
|
/**
|
|
71789
71845
|
* This lists the templates that you have modified for your site.
|
|
71790
71846
|
* @summary List notification templates
|
|
@@ -71792,29 +71848,26 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
71792
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.
|
|
71793
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*
|
|
71794
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**
|
|
71795
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71796
71851
|
* @param {*} [axiosOptions] Override http request option.
|
|
71797
71852
|
* @throws {RequiredError}
|
|
71798
71853
|
*/
|
|
71799
|
-
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string,
|
|
71854
|
+
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71800
71855
|
/**
|
|
71801
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
|
|
71802
71857
|
* @summary Change mail from domain
|
|
71803
71858
|
* @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024
|
|
71804
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71805
71859
|
* @param {*} [axiosOptions] Override http request option.
|
|
71806
71860
|
* @throws {RequiredError}
|
|
71807
71861
|
*/
|
|
71808
|
-
putMailFromAttributes: (mailFromAttributesDtoV2024: MailFromAttributesDtoV2024,
|
|
71862
|
+
putMailFromAttributes: (mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71809
71863
|
/**
|
|
71810
71864
|
* Send a Test Notification
|
|
71811
71865
|
* @summary Send test notification
|
|
71812
71866
|
* @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024
|
|
71813
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71814
71867
|
* @param {*} [axiosOptions] Override http request option.
|
|
71815
71868
|
* @throws {RequiredError}
|
|
71816
71869
|
*/
|
|
71817
|
-
sendTestNotification: (sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024,
|
|
71870
|
+
sendTestNotification: (sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71818
71871
|
};
|
|
71819
71872
|
/**
|
|
71820
71873
|
* NotificationsV2024Api - functional programming interface
|
|
@@ -71825,113 +71878,103 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
71825
71878
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
71826
71879
|
* @summary Verify domain address via dkim
|
|
71827
71880
|
* @param {DomainAddressV2024} domainAddressV2024
|
|
71828
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71829
71881
|
* @param {*} [axiosOptions] Override http request option.
|
|
71830
71882
|
* @throws {RequiredError}
|
|
71831
71883
|
*/
|
|
71832
|
-
createDomainDkim(domainAddressV2024: DomainAddressV2024,
|
|
71884
|
+
createDomainDkim(domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainStatusDtoV2024>>;
|
|
71833
71885
|
/**
|
|
71834
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.
|
|
71835
71887
|
* @summary Create notification template
|
|
71836
71888
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
71837
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71838
71889
|
* @param {*} [axiosOptions] Override http request option.
|
|
71839
71890
|
* @throws {RequiredError}
|
|
71840
71891
|
*/
|
|
71841
|
-
createNotificationTemplate(templateDtoV2024: TemplateDtoV2024,
|
|
71892
|
+
createNotificationTemplate(templateDtoV2024: TemplateDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2024>>;
|
|
71842
71893
|
/**
|
|
71843
71894
|
* Create a new sender email address and initiate verification process.
|
|
71844
71895
|
* @summary Create verified from address
|
|
71845
71896
|
* @param {EmailStatusDtoV2024} emailStatusDtoV2024
|
|
71846
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71847
71897
|
* @param {*} [axiosOptions] Override http request option.
|
|
71848
71898
|
* @throws {RequiredError}
|
|
71849
71899
|
*/
|
|
71850
|
-
createVerifiedFromAddress(emailStatusDtoV2024: EmailStatusDtoV2024,
|
|
71900
|
+
createVerifiedFromAddress(emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailStatusDtoV2024>>;
|
|
71851
71901
|
/**
|
|
71852
71902
|
* This lets you bulk delete templates that you previously created for your site.
|
|
71853
71903
|
* @summary Bulk delete notification templates
|
|
71854
71904
|
* @param {Array<TemplateBulkDeleteDtoV2024>} templateBulkDeleteDtoV2024
|
|
71855
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71856
71905
|
* @param {*} [axiosOptions] Override http request option.
|
|
71857
71906
|
* @throws {RequiredError}
|
|
71858
71907
|
*/
|
|
71859
|
-
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>,
|
|
71908
|
+
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71860
71909
|
/**
|
|
71861
71910
|
* Delete a verified sender email address
|
|
71862
71911
|
* @summary Delete verified from address
|
|
71863
|
-
* @param {string} id
|
|
71864
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71912
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
71865
71913
|
* @param {*} [axiosOptions] Override http request option.
|
|
71866
71914
|
* @throws {RequiredError}
|
|
71867
71915
|
*/
|
|
71868
|
-
deleteVerifiedFromAddress(id: string,
|
|
71916
|
+
deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71869
71917
|
/**
|
|
71870
71918
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
71871
71919
|
* @summary Get dkim attributes
|
|
71872
|
-
* @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.
|
|
71873
71922
|
* @param {*} [axiosOptions] Override http request option.
|
|
71874
71923
|
* @throws {RequiredError}
|
|
71875
71924
|
*/
|
|
71876
|
-
getDkimAttributes(
|
|
71925
|
+
getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DkimAttributesV2024>>>;
|
|
71877
71926
|
/**
|
|
71878
71927
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
71879
71928
|
* @summary Get mail from attributes
|
|
71880
71929
|
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
71881
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71882
71930
|
* @param {*} [axiosOptions] Override http request option.
|
|
71883
71931
|
* @throws {RequiredError}
|
|
71884
71932
|
*/
|
|
71885
|
-
getMailFromAttributes(identity: string,
|
|
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>>;
|
|
71886
71941
|
/**
|
|
71887
71942
|
* This gets a template that you have modified for your site by Id.
|
|
71888
71943
|
* @summary Get notification template by id
|
|
71889
71944
|
* @param {string} id Id of the Notification Template
|
|
71890
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71891
71945
|
* @param {*} [axiosOptions] Override http request option.
|
|
71892
71946
|
* @throws {RequiredError}
|
|
71893
71947
|
*/
|
|
71894
|
-
getNotificationTemplate(id: string,
|
|
71948
|
+
getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2024>>;
|
|
71895
71949
|
/**
|
|
71896
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).
|
|
71897
71951
|
* @summary Get notification template context
|
|
71898
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71899
71952
|
* @param {*} [axiosOptions] Override http request option.
|
|
71900
71953
|
* @throws {RequiredError}
|
|
71901
71954
|
*/
|
|
71902
|
-
getNotificationsTemplateContext(
|
|
71955
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTemplateContextV2024>>;
|
|
71903
71956
|
/**
|
|
71904
71957
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
71905
71958
|
* @summary List from addresses
|
|
71906
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.
|
|
71907
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.
|
|
71908
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.
|
|
71909
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 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*
|
|
71910
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**
|
|
71911
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71912
71964
|
* @param {*} [axiosOptions] Override http request option.
|
|
71913
71965
|
* @throws {RequiredError}
|
|
71914
71966
|
*/
|
|
71915
|
-
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
71916
|
-
/**
|
|
71917
|
-
* Returns a list of notification preferences for tenant.
|
|
71918
|
-
* @summary List notification preferences for tenant.
|
|
71919
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71920
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
71921
|
-
* @throws {RequiredError}
|
|
71922
|
-
*/
|
|
71923
|
-
listNotificationPreferences(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferencesDtoV2024>>;
|
|
71967
|
+
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailStatusDtoV2024>>>;
|
|
71924
71968
|
/**
|
|
71925
71969
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
71926
71970
|
* @summary List notification template defaults
|
|
71927
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.
|
|
71928
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.
|
|
71929
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*
|
|
71930
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71931
71974
|
* @param {*} [axiosOptions] Override http request option.
|
|
71932
71975
|
* @throws {RequiredError}
|
|
71933
71976
|
*/
|
|
71934
|
-
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>>>;
|
|
71935
71978
|
/**
|
|
71936
71979
|
* This lists the templates that you have modified for your site.
|
|
71937
71980
|
* @summary List notification templates
|
|
@@ -71939,29 +71982,26 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
71939
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.
|
|
71940
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*
|
|
71941
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**
|
|
71942
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71943
71985
|
* @param {*} [axiosOptions] Override http request option.
|
|
71944
71986
|
* @throws {RequiredError}
|
|
71945
71987
|
*/
|
|
71946
|
-
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>>>;
|
|
71947
71989
|
/**
|
|
71948
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
|
|
71949
71991
|
* @summary Change mail from domain
|
|
71950
71992
|
* @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024
|
|
71951
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71952
71993
|
* @param {*} [axiosOptions] Override http request option.
|
|
71953
71994
|
* @throws {RequiredError}
|
|
71954
71995
|
*/
|
|
71955
|
-
putMailFromAttributes(mailFromAttributesDtoV2024: MailFromAttributesDtoV2024,
|
|
71996
|
+
putMailFromAttributes(mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MailFromAttributesV2024>>;
|
|
71956
71997
|
/**
|
|
71957
71998
|
* Send a Test Notification
|
|
71958
71999
|
* @summary Send test notification
|
|
71959
72000
|
* @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024
|
|
71960
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
71961
72001
|
* @param {*} [axiosOptions] Override http request option.
|
|
71962
72002
|
* @throws {RequiredError}
|
|
71963
72003
|
*/
|
|
71964
|
-
sendTestNotification(sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024,
|
|
72004
|
+
sendTestNotification(sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
71965
72005
|
};
|
|
71966
72006
|
/**
|
|
71967
72007
|
* NotificationsV2024Api - factory interface
|
|
@@ -72024,6 +72064,13 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
72024
72064
|
* @throws {RequiredError}
|
|
72025
72065
|
*/
|
|
72026
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>;
|
|
72027
72074
|
/**
|
|
72028
72075
|
* This gets a template that you have modified for your site by Id.
|
|
72029
72076
|
* @summary Get notification template by id
|
|
@@ -72035,11 +72082,10 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
72035
72082
|
/**
|
|
72036
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).
|
|
72037
72084
|
* @summary Get notification template context
|
|
72038
|
-
* @param {NotificationsV2024ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
72039
72085
|
* @param {*} [axiosOptions] Override http request option.
|
|
72040
72086
|
* @throws {RequiredError}
|
|
72041
72087
|
*/
|
|
72042
|
-
getNotificationsTemplateContext(
|
|
72088
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<NotificationTemplateContextV2024>;
|
|
72043
72089
|
/**
|
|
72044
72090
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
72045
72091
|
* @summary List from addresses
|
|
@@ -72048,14 +72094,6 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
72048
72094
|
* @throws {RequiredError}
|
|
72049
72095
|
*/
|
|
72050
72096
|
listFromAddresses(requestParameters?: NotificationsV2024ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EmailStatusDtoV2024>>;
|
|
72051
|
-
/**
|
|
72052
|
-
* Returns a list of notification preferences for tenant.
|
|
72053
|
-
* @summary List notification preferences for tenant.
|
|
72054
|
-
* @param {NotificationsV2024ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
72055
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
72056
|
-
* @throws {RequiredError}
|
|
72057
|
-
*/
|
|
72058
|
-
listNotificationPreferences(requestParameters?: NotificationsV2024ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PreferencesDtoV2024>;
|
|
72059
72097
|
/**
|
|
72060
72098
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
72061
72099
|
* @summary List notification template defaults
|
|
@@ -72101,12 +72139,6 @@ export interface NotificationsV2024ApiCreateDomainDkimRequest {
|
|
|
72101
72139
|
* @memberof NotificationsV2024ApiCreateDomainDkim
|
|
72102
72140
|
*/
|
|
72103
72141
|
readonly domainAddressV2024: DomainAddressV2024;
|
|
72104
|
-
/**
|
|
72105
|
-
* Use this header to enable this experimental API.
|
|
72106
|
-
* @type {string}
|
|
72107
|
-
* @memberof NotificationsV2024ApiCreateDomainDkim
|
|
72108
|
-
*/
|
|
72109
|
-
readonly xSailPointExperimental?: string;
|
|
72110
72142
|
}
|
|
72111
72143
|
/**
|
|
72112
72144
|
* Request parameters for createNotificationTemplate operation in NotificationsV2024Api.
|
|
@@ -72120,12 +72152,6 @@ export interface NotificationsV2024ApiCreateNotificationTemplateRequest {
|
|
|
72120
72152
|
* @memberof NotificationsV2024ApiCreateNotificationTemplate
|
|
72121
72153
|
*/
|
|
72122
72154
|
readonly templateDtoV2024: TemplateDtoV2024;
|
|
72123
|
-
/**
|
|
72124
|
-
* Use this header to enable this experimental API.
|
|
72125
|
-
* @type {string}
|
|
72126
|
-
* @memberof NotificationsV2024ApiCreateNotificationTemplate
|
|
72127
|
-
*/
|
|
72128
|
-
readonly xSailPointExperimental?: string;
|
|
72129
72155
|
}
|
|
72130
72156
|
/**
|
|
72131
72157
|
* Request parameters for createVerifiedFromAddress operation in NotificationsV2024Api.
|
|
@@ -72139,12 +72165,6 @@ export interface NotificationsV2024ApiCreateVerifiedFromAddressRequest {
|
|
|
72139
72165
|
* @memberof NotificationsV2024ApiCreateVerifiedFromAddress
|
|
72140
72166
|
*/
|
|
72141
72167
|
readonly emailStatusDtoV2024: EmailStatusDtoV2024;
|
|
72142
|
-
/**
|
|
72143
|
-
* Use this header to enable this experimental API.
|
|
72144
|
-
* @type {string}
|
|
72145
|
-
* @memberof NotificationsV2024ApiCreateVerifiedFromAddress
|
|
72146
|
-
*/
|
|
72147
|
-
readonly xSailPointExperimental?: string;
|
|
72148
72168
|
}
|
|
72149
72169
|
/**
|
|
72150
72170
|
* Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2024Api.
|
|
@@ -72158,12 +72178,6 @@ export interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
72158
72178
|
* @memberof NotificationsV2024ApiDeleteNotificationTemplatesInBulk
|
|
72159
72179
|
*/
|
|
72160
72180
|
readonly templateBulkDeleteDtoV2024: Array<TemplateBulkDeleteDtoV2024>;
|
|
72161
|
-
/**
|
|
72162
|
-
* Use this header to enable this experimental API.
|
|
72163
|
-
* @type {string}
|
|
72164
|
-
* @memberof NotificationsV2024ApiDeleteNotificationTemplatesInBulk
|
|
72165
|
-
*/
|
|
72166
|
-
readonly xSailPointExperimental?: string;
|
|
72167
72181
|
}
|
|
72168
72182
|
/**
|
|
72169
72183
|
* Request parameters for deleteVerifiedFromAddress operation in NotificationsV2024Api.
|
|
@@ -72172,17 +72186,11 @@ export interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
72172
72186
|
*/
|
|
72173
72187
|
export interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest {
|
|
72174
72188
|
/**
|
|
72175
|
-
*
|
|
72189
|
+
* Unique identifier of the verified sender address to delete.
|
|
72176
72190
|
* @type {string}
|
|
72177
72191
|
* @memberof NotificationsV2024ApiDeleteVerifiedFromAddress
|
|
72178
72192
|
*/
|
|
72179
72193
|
readonly id: string;
|
|
72180
|
-
/**
|
|
72181
|
-
* Use this header to enable this experimental API.
|
|
72182
|
-
* @type {string}
|
|
72183
|
-
* @memberof NotificationsV2024ApiDeleteVerifiedFromAddress
|
|
72184
|
-
*/
|
|
72185
|
-
readonly xSailPointExperimental?: string;
|
|
72186
72194
|
}
|
|
72187
72195
|
/**
|
|
72188
72196
|
* Request parameters for getDkimAttributes operation in NotificationsV2024Api.
|
|
@@ -72191,11 +72199,17 @@ export interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest {
|
|
|
72191
72199
|
*/
|
|
72192
72200
|
export interface NotificationsV2024ApiGetDkimAttributesRequest {
|
|
72193
72201
|
/**
|
|
72194
|
-
*
|
|
72195
|
-
* @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}
|
|
72196
72204
|
* @memberof NotificationsV2024ApiGetDkimAttributes
|
|
72197
72205
|
*/
|
|
72198
|
-
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;
|
|
72199
72213
|
}
|
|
72200
72214
|
/**
|
|
72201
72215
|
* Request parameters for getMailFromAttributes operation in NotificationsV2024Api.
|
|
@@ -72209,12 +72223,6 @@ export interface NotificationsV2024ApiGetMailFromAttributesRequest {
|
|
|
72209
72223
|
* @memberof NotificationsV2024ApiGetMailFromAttributes
|
|
72210
72224
|
*/
|
|
72211
72225
|
readonly identity: string;
|
|
72212
|
-
/**
|
|
72213
|
-
* Use this header to enable this experimental API.
|
|
72214
|
-
* @type {string}
|
|
72215
|
-
* @memberof NotificationsV2024ApiGetMailFromAttributes
|
|
72216
|
-
*/
|
|
72217
|
-
readonly xSailPointExperimental?: string;
|
|
72218
72226
|
}
|
|
72219
72227
|
/**
|
|
72220
72228
|
* Request parameters for getNotificationTemplate operation in NotificationsV2024Api.
|
|
@@ -72228,25 +72236,6 @@ export interface NotificationsV2024ApiGetNotificationTemplateRequest {
|
|
|
72228
72236
|
* @memberof NotificationsV2024ApiGetNotificationTemplate
|
|
72229
72237
|
*/
|
|
72230
72238
|
readonly id: string;
|
|
72231
|
-
/**
|
|
72232
|
-
* Use this header to enable this experimental API.
|
|
72233
|
-
* @type {string}
|
|
72234
|
-
* @memberof NotificationsV2024ApiGetNotificationTemplate
|
|
72235
|
-
*/
|
|
72236
|
-
readonly xSailPointExperimental?: string;
|
|
72237
|
-
}
|
|
72238
|
-
/**
|
|
72239
|
-
* Request parameters for getNotificationsTemplateContext operation in NotificationsV2024Api.
|
|
72240
|
-
* @export
|
|
72241
|
-
* @interface NotificationsV2024ApiGetNotificationsTemplateContextRequest
|
|
72242
|
-
*/
|
|
72243
|
-
export interface NotificationsV2024ApiGetNotificationsTemplateContextRequest {
|
|
72244
|
-
/**
|
|
72245
|
-
* Use this header to enable this experimental API.
|
|
72246
|
-
* @type {string}
|
|
72247
|
-
* @memberof NotificationsV2024ApiGetNotificationsTemplateContext
|
|
72248
|
-
*/
|
|
72249
|
-
readonly xSailPointExperimental?: string;
|
|
72250
72239
|
}
|
|
72251
72240
|
/**
|
|
72252
72241
|
* Request parameters for listFromAddresses operation in NotificationsV2024Api.
|
|
@@ -72273,7 +72262,7 @@ export interface NotificationsV2024ApiListFromAddressesRequest {
|
|
|
72273
72262
|
*/
|
|
72274
72263
|
readonly count?: boolean;
|
|
72275
72264
|
/**
|
|
72276
|
-
* Filter results using the standard syntax described in [V3 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*
|
|
72277
72266
|
* @type {string}
|
|
72278
72267
|
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72279
72268
|
*/
|
|
@@ -72284,25 +72273,6 @@ export interface NotificationsV2024ApiListFromAddressesRequest {
|
|
|
72284
72273
|
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72285
72274
|
*/
|
|
72286
72275
|
readonly sorters?: string;
|
|
72287
|
-
/**
|
|
72288
|
-
* Use this header to enable this experimental API.
|
|
72289
|
-
* @type {string}
|
|
72290
|
-
* @memberof NotificationsV2024ApiListFromAddresses
|
|
72291
|
-
*/
|
|
72292
|
-
readonly xSailPointExperimental?: string;
|
|
72293
|
-
}
|
|
72294
|
-
/**
|
|
72295
|
-
* Request parameters for listNotificationPreferences operation in NotificationsV2024Api.
|
|
72296
|
-
* @export
|
|
72297
|
-
* @interface NotificationsV2024ApiListNotificationPreferencesRequest
|
|
72298
|
-
*/
|
|
72299
|
-
export interface NotificationsV2024ApiListNotificationPreferencesRequest {
|
|
72300
|
-
/**
|
|
72301
|
-
* Use this header to enable this experimental API.
|
|
72302
|
-
* @type {string}
|
|
72303
|
-
* @memberof NotificationsV2024ApiListNotificationPreferences
|
|
72304
|
-
*/
|
|
72305
|
-
readonly xSailPointExperimental?: string;
|
|
72306
72276
|
}
|
|
72307
72277
|
/**
|
|
72308
72278
|
* Request parameters for listNotificationTemplateDefaults operation in NotificationsV2024Api.
|
|
@@ -72328,12 +72298,6 @@ export interface NotificationsV2024ApiListNotificationTemplateDefaultsRequest {
|
|
|
72328
72298
|
* @memberof NotificationsV2024ApiListNotificationTemplateDefaults
|
|
72329
72299
|
*/
|
|
72330
72300
|
readonly filters?: string;
|
|
72331
|
-
/**
|
|
72332
|
-
* Use this header to enable this experimental API.
|
|
72333
|
-
* @type {string}
|
|
72334
|
-
* @memberof NotificationsV2024ApiListNotificationTemplateDefaults
|
|
72335
|
-
*/
|
|
72336
|
-
readonly xSailPointExperimental?: string;
|
|
72337
72301
|
}
|
|
72338
72302
|
/**
|
|
72339
72303
|
* Request parameters for listNotificationTemplates operation in NotificationsV2024Api.
|
|
@@ -72365,12 +72329,6 @@ export interface NotificationsV2024ApiListNotificationTemplatesRequest {
|
|
|
72365
72329
|
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
72366
72330
|
*/
|
|
72367
72331
|
readonly sorters?: string;
|
|
72368
|
-
/**
|
|
72369
|
-
* Use this header to enable this experimental API.
|
|
72370
|
-
* @type {string}
|
|
72371
|
-
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
72372
|
-
*/
|
|
72373
|
-
readonly xSailPointExperimental?: string;
|
|
72374
72332
|
}
|
|
72375
72333
|
/**
|
|
72376
72334
|
* Request parameters for putMailFromAttributes operation in NotificationsV2024Api.
|
|
@@ -72384,12 +72342,6 @@ export interface NotificationsV2024ApiPutMailFromAttributesRequest {
|
|
|
72384
72342
|
* @memberof NotificationsV2024ApiPutMailFromAttributes
|
|
72385
72343
|
*/
|
|
72386
72344
|
readonly mailFromAttributesDtoV2024: MailFromAttributesDtoV2024;
|
|
72387
|
-
/**
|
|
72388
|
-
* Use this header to enable this experimental API.
|
|
72389
|
-
* @type {string}
|
|
72390
|
-
* @memberof NotificationsV2024ApiPutMailFromAttributes
|
|
72391
|
-
*/
|
|
72392
|
-
readonly xSailPointExperimental?: string;
|
|
72393
72345
|
}
|
|
72394
72346
|
/**
|
|
72395
72347
|
* Request parameters for sendTestNotification operation in NotificationsV2024Api.
|
|
@@ -72403,12 +72355,6 @@ export interface NotificationsV2024ApiSendTestNotificationRequest {
|
|
|
72403
72355
|
* @memberof NotificationsV2024ApiSendTestNotification
|
|
72404
72356
|
*/
|
|
72405
72357
|
readonly sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024;
|
|
72406
|
-
/**
|
|
72407
|
-
* Use this header to enable this experimental API.
|
|
72408
|
-
* @type {string}
|
|
72409
|
-
* @memberof NotificationsV2024ApiSendTestNotification
|
|
72410
|
-
*/
|
|
72411
|
-
readonly xSailPointExperimental?: string;
|
|
72412
72358
|
}
|
|
72413
72359
|
/**
|
|
72414
72360
|
* NotificationsV2024Api - object-oriented interface
|
|
@@ -72480,6 +72426,14 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72480
72426
|
* @memberof NotificationsV2024Api
|
|
72481
72427
|
*/
|
|
72482
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>>;
|
|
72483
72437
|
/**
|
|
72484
72438
|
* This gets a template that you have modified for your site by Id.
|
|
72485
72439
|
* @summary Get notification template by id
|
|
@@ -72492,12 +72446,11 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72492
72446
|
/**
|
|
72493
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).
|
|
72494
72448
|
* @summary Get notification template context
|
|
72495
|
-
* @param {NotificationsV2024ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
72496
72449
|
* @param {*} [axiosOptions] Override http request option.
|
|
72497
72450
|
* @throws {RequiredError}
|
|
72498
72451
|
* @memberof NotificationsV2024Api
|
|
72499
72452
|
*/
|
|
72500
|
-
getNotificationsTemplateContext(
|
|
72453
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationTemplateContextV2024, any>>;
|
|
72501
72454
|
/**
|
|
72502
72455
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
72503
72456
|
* @summary List from addresses
|
|
@@ -72507,15 +72460,6 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
72507
72460
|
* @memberof NotificationsV2024Api
|
|
72508
72461
|
*/
|
|
72509
72462
|
listFromAddresses(requestParameters?: NotificationsV2024ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailStatusDtoV2024[], any>>;
|
|
72510
|
-
/**
|
|
72511
|
-
* Returns a list of notification preferences for tenant.
|
|
72512
|
-
* @summary List notification preferences for tenant.
|
|
72513
|
-
* @param {NotificationsV2024ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
72514
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
72515
|
-
* @throws {RequiredError}
|
|
72516
|
-
* @memberof NotificationsV2024Api
|
|
72517
|
-
*/
|
|
72518
|
-
listNotificationPreferences(requestParameters?: NotificationsV2024ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferencesDtoV2024, any>>;
|
|
72519
72463
|
/**
|
|
72520
72464
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
72521
72465
|
* @summary List notification template defaults
|