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/v2025/api.d.ts
CHANGED
|
@@ -17000,7 +17000,7 @@ export interface EmailStatusDtoV2025 {
|
|
|
17000
17000
|
* @type {string}
|
|
17001
17001
|
* @memberof EmailStatusDtoV2025
|
|
17002
17002
|
*/
|
|
17003
|
-
'region'?: string;
|
|
17003
|
+
'region'?: string | null;
|
|
17004
17004
|
}
|
|
17005
17005
|
export declare const EmailStatusDtoV2025VerificationStatusV2025: {
|
|
17006
17006
|
readonly Pending: "PENDING";
|
|
@@ -17897,6 +17897,12 @@ export interface EntitlementV2025 {
|
|
|
17897
17897
|
* @memberof EntitlementV2025
|
|
17898
17898
|
*/
|
|
17899
17899
|
'owner'?: EntitlementOwnerV2025 | null;
|
|
17900
|
+
/**
|
|
17901
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
17902
|
+
* @type {Array<AdditionalOwnerRefV2025>}
|
|
17903
|
+
* @memberof EntitlementV2025
|
|
17904
|
+
*/
|
|
17905
|
+
'additionalOwners'?: Array<AdditionalOwnerRefV2025> | null;
|
|
17900
17906
|
/**
|
|
17901
17907
|
* 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.
|
|
17902
17908
|
* @type {{ [key: string]: any; }}
|
|
@@ -20263,11 +20269,29 @@ export interface FullDiscoveredApplicationsV2025 {
|
|
|
20263
20269
|
*/
|
|
20264
20270
|
'environment'?: string;
|
|
20265
20271
|
/**
|
|
20266
|
-
* The risk score of the application.
|
|
20272
|
+
* The risk score of the application ranging from 0-100, 100 being highest risk.
|
|
20273
|
+
* @type {number}
|
|
20274
|
+
* @memberof FullDiscoveredApplicationsV2025
|
|
20275
|
+
*/
|
|
20276
|
+
'riskScore'?: number;
|
|
20277
|
+
/**
|
|
20278
|
+
* Indicates whether the application is used for business purposes.
|
|
20279
|
+
* @type {boolean}
|
|
20280
|
+
* @memberof FullDiscoveredApplicationsV2025
|
|
20281
|
+
*/
|
|
20282
|
+
'isBusiness'?: boolean;
|
|
20283
|
+
/**
|
|
20284
|
+
* The total number of sign-in accounts for the application.
|
|
20285
|
+
* @type {number}
|
|
20286
|
+
* @memberof FullDiscoveredApplicationsV2025
|
|
20287
|
+
*/
|
|
20288
|
+
'totalSigninsCount'?: number;
|
|
20289
|
+
/**
|
|
20290
|
+
* The risk level of the application.
|
|
20267
20291
|
* @type {string}
|
|
20268
20292
|
* @memberof FullDiscoveredApplicationsV2025
|
|
20269
20293
|
*/
|
|
20270
|
-
'
|
|
20294
|
+
'riskLevel'?: FullDiscoveredApplicationsV2025RiskLevelV2025;
|
|
20271
20295
|
/**
|
|
20272
20296
|
* Indicates whether the application has privileged access.
|
|
20273
20297
|
* @type {boolean}
|
|
@@ -20287,6 +20311,12 @@ export interface FullDiscoveredApplicationsV2025 {
|
|
|
20287
20311
|
*/
|
|
20288
20312
|
'attributes'?: object;
|
|
20289
20313
|
}
|
|
20314
|
+
export declare const FullDiscoveredApplicationsV2025RiskLevelV2025: {
|
|
20315
|
+
readonly High: "High";
|
|
20316
|
+
readonly Medium: "Medium";
|
|
20317
|
+
readonly Low: "Low";
|
|
20318
|
+
};
|
|
20319
|
+
export type FullDiscoveredApplicationsV2025RiskLevelV2025 = typeof FullDiscoveredApplicationsV2025RiskLevelV2025[keyof typeof FullDiscoveredApplicationsV2025RiskLevelV2025];
|
|
20290
20320
|
/**
|
|
20291
20321
|
*
|
|
20292
20322
|
* @export
|
|
@@ -43384,11 +43414,29 @@ export interface SlimDiscoveredApplicationsV2025 {
|
|
|
43384
43414
|
*/
|
|
43385
43415
|
'environment'?: string;
|
|
43386
43416
|
/**
|
|
43387
|
-
* The risk score of the application.
|
|
43417
|
+
* The risk score of the application ranging from 0-100, 100 being highest risk.
|
|
43418
|
+
* @type {number}
|
|
43419
|
+
* @memberof SlimDiscoveredApplicationsV2025
|
|
43420
|
+
*/
|
|
43421
|
+
'riskScore'?: number;
|
|
43422
|
+
/**
|
|
43423
|
+
* Indicates whether the application is used for business purposes.
|
|
43424
|
+
* @type {boolean}
|
|
43425
|
+
* @memberof SlimDiscoveredApplicationsV2025
|
|
43426
|
+
*/
|
|
43427
|
+
'isBusiness'?: boolean;
|
|
43428
|
+
/**
|
|
43429
|
+
* The total number of sign-in accounts for the application.
|
|
43430
|
+
* @type {number}
|
|
43431
|
+
* @memberof SlimDiscoveredApplicationsV2025
|
|
43432
|
+
*/
|
|
43433
|
+
'totalSigninsCount'?: number;
|
|
43434
|
+
/**
|
|
43435
|
+
* The risk level of the application.
|
|
43388
43436
|
* @type {string}
|
|
43389
43437
|
* @memberof SlimDiscoveredApplicationsV2025
|
|
43390
43438
|
*/
|
|
43391
|
-
'
|
|
43439
|
+
'riskLevel'?: SlimDiscoveredApplicationsV2025RiskLevelV2025;
|
|
43392
43440
|
/**
|
|
43393
43441
|
* Indicates whether the application has privileged access.
|
|
43394
43442
|
* @type {boolean}
|
|
@@ -43408,6 +43456,12 @@ export interface SlimDiscoveredApplicationsV2025 {
|
|
|
43408
43456
|
*/
|
|
43409
43457
|
'attributes'?: object;
|
|
43410
43458
|
}
|
|
43459
|
+
export declare const SlimDiscoveredApplicationsV2025RiskLevelV2025: {
|
|
43460
|
+
readonly High: "High";
|
|
43461
|
+
readonly Medium: "Medium";
|
|
43462
|
+
readonly Low: "Low";
|
|
43463
|
+
};
|
|
43464
|
+
export type SlimDiscoveredApplicationsV2025RiskLevelV2025 = typeof SlimDiscoveredApplicationsV2025RiskLevelV2025[keyof typeof SlimDiscoveredApplicationsV2025RiskLevelV2025];
|
|
43411
43465
|
/**
|
|
43412
43466
|
* Details of the Entitlement criteria
|
|
43413
43467
|
* @export
|
|
@@ -46235,6 +46289,24 @@ export declare const StandardLevelV2025: {
|
|
|
46235
46289
|
readonly Trace: "TRACE";
|
|
46236
46290
|
};
|
|
46237
46291
|
export type StandardLevelV2025 = typeof StandardLevelV2025[keyof typeof StandardLevelV2025];
|
|
46292
|
+
/**
|
|
46293
|
+
*
|
|
46294
|
+
* @export
|
|
46295
|
+
* @interface StartApplicationDiscovery403ResponseOneOfV2025
|
|
46296
|
+
*/
|
|
46297
|
+
export interface StartApplicationDiscovery403ResponseOneOfV2025 {
|
|
46298
|
+
/**
|
|
46299
|
+
* Error message when quota is exceeded
|
|
46300
|
+
* @type {string}
|
|
46301
|
+
* @memberof StartApplicationDiscovery403ResponseOneOfV2025
|
|
46302
|
+
*/
|
|
46303
|
+
'error': string;
|
|
46304
|
+
}
|
|
46305
|
+
/**
|
|
46306
|
+
* @type StartApplicationDiscovery403ResponseV2025
|
|
46307
|
+
* @export
|
|
46308
|
+
*/
|
|
46309
|
+
export type StartApplicationDiscovery403ResponseV2025 = ErrorResponseDtoV2025 | StartApplicationDiscovery403ResponseOneOfV2025;
|
|
46238
46310
|
/**
|
|
46239
46311
|
*
|
|
46240
46312
|
* @export
|
|
@@ -55402,11 +55474,10 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
55402
55474
|
* Currently this endpoint only supports Entitlement Description Approvals. 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.
|
|
55403
55475
|
* @summary Get an approval
|
|
55404
55476
|
* @param {string} id ID of the approval that is to be returned
|
|
55405
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
55406
55477
|
* @param {*} [axiosOptions] Override http request option.
|
|
55407
55478
|
* @throws {RequiredError}
|
|
55408
55479
|
*/
|
|
55409
|
-
getApproval: (id: string,
|
|
55480
|
+
getApproval: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55410
55481
|
/**
|
|
55411
55482
|
* Currently this endpoint only supports Entitlement Description Approvals. Get a list of approvals. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
55412
55483
|
* @summary Get approvals
|
|
@@ -55540,11 +55611,10 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
55540
55611
|
* Currently this endpoint only supports Entitlement Description Approvals. 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.
|
|
55541
55612
|
* @summary Get an approval
|
|
55542
55613
|
* @param {string} id ID of the approval that is to be returned
|
|
55543
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
55544
55614
|
* @param {*} [axiosOptions] Override http request option.
|
|
55545
55615
|
* @throws {RequiredError}
|
|
55546
55616
|
*/
|
|
55547
|
-
getApproval(id: string,
|
|
55617
|
+
getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
55548
55618
|
/**
|
|
55549
55619
|
* Currently this endpoint only supports Entitlement Description Approvals. Get a list of approvals. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. Absence of all query parameters for non admins will will default to mine=true. Admin will default to mine=false. Absence of all query parameters for admins will return all approvals in the org.
|
|
55550
55620
|
* @summary Get approvals
|
|
@@ -55829,12 +55899,6 @@ export interface ApprovalsV2025ApiGetApprovalRequest {
|
|
|
55829
55899
|
* @memberof ApprovalsV2025ApiGetApproval
|
|
55830
55900
|
*/
|
|
55831
55901
|
readonly id: string;
|
|
55832
|
-
/**
|
|
55833
|
-
* Use this header to enable this experimental API.
|
|
55834
|
-
* @type {string}
|
|
55835
|
-
* @memberof ApprovalsV2025ApiGetApproval
|
|
55836
|
-
*/
|
|
55837
|
-
readonly xSailPointExperimental?: string;
|
|
55838
55902
|
}
|
|
55839
55903
|
/**
|
|
55840
55904
|
* Request parameters for getApprovals operation in ApprovalsV2025Api.
|
|
@@ -82046,113 +82110,103 @@ export declare const NotificationsV2025ApiAxiosParamCreator: (configuration?: Co
|
|
|
82046
82110
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
82047
82111
|
* @summary Verify domain address via dkim
|
|
82048
82112
|
* @param {DomainAddressV2025} domainAddressV2025
|
|
82049
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82050
82113
|
* @param {*} [axiosOptions] Override http request option.
|
|
82051
82114
|
* @throws {RequiredError}
|
|
82052
82115
|
*/
|
|
82053
|
-
createDomainDkim: (domainAddressV2025: DomainAddressV2025,
|
|
82116
|
+
createDomainDkim: (domainAddressV2025: DomainAddressV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82054
82117
|
/**
|
|
82055
82118
|
* 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.
|
|
82056
82119
|
* @summary Create notification template
|
|
82057
82120
|
* @param {TemplateDtoV2025} templateDtoV2025
|
|
82058
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82059
82121
|
* @param {*} [axiosOptions] Override http request option.
|
|
82060
82122
|
* @throws {RequiredError}
|
|
82061
82123
|
*/
|
|
82062
|
-
createNotificationTemplate: (templateDtoV2025: TemplateDtoV2025,
|
|
82124
|
+
createNotificationTemplate: (templateDtoV2025: TemplateDtoV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82063
82125
|
/**
|
|
82064
82126
|
* Create a new sender email address and initiate verification process.
|
|
82065
82127
|
* @summary Create verified from address
|
|
82066
82128
|
* @param {EmailStatusDtoV2025} emailStatusDtoV2025
|
|
82067
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82068
82129
|
* @param {*} [axiosOptions] Override http request option.
|
|
82069
82130
|
* @throws {RequiredError}
|
|
82070
82131
|
*/
|
|
82071
|
-
createVerifiedFromAddress: (emailStatusDtoV2025: EmailStatusDtoV2025,
|
|
82132
|
+
createVerifiedFromAddress: (emailStatusDtoV2025: EmailStatusDtoV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82072
82133
|
/**
|
|
82073
82134
|
* This lets you bulk delete templates that you previously created for your site.
|
|
82074
82135
|
* @summary Bulk delete notification templates
|
|
82075
82136
|
* @param {Array<TemplateBulkDeleteDtoV2025>} templateBulkDeleteDtoV2025
|
|
82076
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82077
82137
|
* @param {*} [axiosOptions] Override http request option.
|
|
82078
82138
|
* @throws {RequiredError}
|
|
82079
82139
|
*/
|
|
82080
|
-
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2025: Array<TemplateBulkDeleteDtoV2025>,
|
|
82140
|
+
deleteNotificationTemplatesInBulk: (templateBulkDeleteDtoV2025: Array<TemplateBulkDeleteDtoV2025>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82081
82141
|
/**
|
|
82082
82142
|
* Delete a verified sender email address
|
|
82083
82143
|
* @summary Delete verified from address
|
|
82084
|
-
* @param {string} id
|
|
82085
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82144
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
82086
82145
|
* @param {*} [axiosOptions] Override http request option.
|
|
82087
82146
|
* @throws {RequiredError}
|
|
82088
82147
|
*/
|
|
82089
|
-
deleteVerifiedFromAddress: (id: string,
|
|
82148
|
+
deleteVerifiedFromAddress: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82090
82149
|
/**
|
|
82091
82150
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
82092
82151
|
* @summary Get dkim attributes
|
|
82093
|
-
* @param {
|
|
82152
|
+
* @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.
|
|
82153
|
+
* @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.
|
|
82094
82154
|
* @param {*} [axiosOptions] Override http request option.
|
|
82095
82155
|
* @throws {RequiredError}
|
|
82096
82156
|
*/
|
|
82097
|
-
getDkimAttributes: (
|
|
82157
|
+
getDkimAttributes: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82098
82158
|
/**
|
|
82099
82159
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
82100
82160
|
* @summary Get mail from attributes
|
|
82101
82161
|
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
82102
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82103
82162
|
* @param {*} [axiosOptions] Override http request option.
|
|
82104
82163
|
* @throws {RequiredError}
|
|
82105
82164
|
*/
|
|
82106
|
-
getMailFromAttributes: (identity: string,
|
|
82165
|
+
getMailFromAttributes: (identity: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82166
|
+
/**
|
|
82167
|
+
* Returns a list of notification preferences for tenant.
|
|
82168
|
+
* @summary List notification preferences for tenant.
|
|
82169
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82170
|
+
* @throws {RequiredError}
|
|
82171
|
+
*/
|
|
82172
|
+
getNotificationPreferences: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82107
82173
|
/**
|
|
82108
82174
|
* This gets a template that you have modified for your site by Id.
|
|
82109
82175
|
* @summary Get notification template by id
|
|
82110
82176
|
* @param {string} id Id of the Notification Template
|
|
82111
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82112
82177
|
* @param {*} [axiosOptions] Override http request option.
|
|
82113
82178
|
* @throws {RequiredError}
|
|
82114
82179
|
*/
|
|
82115
|
-
getNotificationTemplate: (id: string,
|
|
82180
|
+
getNotificationTemplate: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82116
82181
|
/**
|
|
82117
82182
|
* 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).
|
|
82118
82183
|
* @summary Get notification template context
|
|
82119
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82120
82184
|
* @param {*} [axiosOptions] Override http request option.
|
|
82121
82185
|
* @throws {RequiredError}
|
|
82122
82186
|
*/
|
|
82123
|
-
getNotificationsTemplateContext: (
|
|
82187
|
+
getNotificationsTemplateContext: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82124
82188
|
/**
|
|
82125
82189
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
82126
82190
|
* @summary List from addresses
|
|
82127
82191
|
* @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.
|
|
82128
82192
|
* @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.
|
|
82129
82193
|
* @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.
|
|
82130
|
-
* @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,
|
|
82194
|
+
* @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*
|
|
82131
82195
|
* @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**
|
|
82132
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82133
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82134
|
-
* @throws {RequiredError}
|
|
82135
|
-
*/
|
|
82136
|
-
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82137
|
-
/**
|
|
82138
|
-
* Returns a list of notification preferences for tenant.
|
|
82139
|
-
* @summary List notification preferences for tenant.
|
|
82140
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82141
82196
|
* @param {*} [axiosOptions] Override http request option.
|
|
82142
82197
|
* @throws {RequiredError}
|
|
82143
82198
|
*/
|
|
82144
|
-
|
|
82199
|
+
listFromAddresses: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82145
82200
|
/**
|
|
82146
82201
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
82147
82202
|
* @summary List notification template defaults
|
|
82148
82203
|
* @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.
|
|
82149
82204
|
* @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.
|
|
82150
82205
|
* @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*
|
|
82151
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82152
82206
|
* @param {*} [axiosOptions] Override http request option.
|
|
82153
82207
|
* @throws {RequiredError}
|
|
82154
82208
|
*/
|
|
82155
|
-
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string,
|
|
82209
|
+
listNotificationTemplateDefaults: (limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82156
82210
|
/**
|
|
82157
82211
|
* This lists the templates that you have modified for your site.
|
|
82158
82212
|
* @summary List notification templates
|
|
@@ -82160,29 +82214,26 @@ export declare const NotificationsV2025ApiAxiosParamCreator: (configuration?: Co
|
|
|
82160
82214
|
* @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.
|
|
82161
82215
|
* @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*
|
|
82162
82216
|
* @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**
|
|
82163
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82164
82217
|
* @param {*} [axiosOptions] Override http request option.
|
|
82165
82218
|
* @throws {RequiredError}
|
|
82166
82219
|
*/
|
|
82167
|
-
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string,
|
|
82220
|
+
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82168
82221
|
/**
|
|
82169
82222
|
* 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
|
|
82170
82223
|
* @summary Change mail from domain
|
|
82171
82224
|
* @param {MailFromAttributesDtoV2025} mailFromAttributesDtoV2025
|
|
82172
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82173
82225
|
* @param {*} [axiosOptions] Override http request option.
|
|
82174
82226
|
* @throws {RequiredError}
|
|
82175
82227
|
*/
|
|
82176
|
-
putMailFromAttributes: (mailFromAttributesDtoV2025: MailFromAttributesDtoV2025,
|
|
82228
|
+
putMailFromAttributes: (mailFromAttributesDtoV2025: MailFromAttributesDtoV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82177
82229
|
/**
|
|
82178
82230
|
* Send a Test Notification
|
|
82179
82231
|
* @summary Send test notification
|
|
82180
82232
|
* @param {SendTestNotificationRequestDtoV2025} sendTestNotificationRequestDtoV2025
|
|
82181
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82182
82233
|
* @param {*} [axiosOptions] Override http request option.
|
|
82183
82234
|
* @throws {RequiredError}
|
|
82184
82235
|
*/
|
|
82185
|
-
sendTestNotification: (sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025,
|
|
82236
|
+
sendTestNotification: (sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82186
82237
|
};
|
|
82187
82238
|
/**
|
|
82188
82239
|
* NotificationsV2025Api - functional programming interface
|
|
@@ -82193,113 +82244,103 @@ export declare const NotificationsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
82193
82244
|
* Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
|
82194
82245
|
* @summary Verify domain address via dkim
|
|
82195
82246
|
* @param {DomainAddressV2025} domainAddressV2025
|
|
82196
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82197
82247
|
* @param {*} [axiosOptions] Override http request option.
|
|
82198
82248
|
* @throws {RequiredError}
|
|
82199
82249
|
*/
|
|
82200
|
-
createDomainDkim(domainAddressV2025: DomainAddressV2025,
|
|
82250
|
+
createDomainDkim(domainAddressV2025: DomainAddressV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainStatusDtoV2025>>;
|
|
82201
82251
|
/**
|
|
82202
82252
|
* 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.
|
|
82203
82253
|
* @summary Create notification template
|
|
82204
82254
|
* @param {TemplateDtoV2025} templateDtoV2025
|
|
82205
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82206
82255
|
* @param {*} [axiosOptions] Override http request option.
|
|
82207
82256
|
* @throws {RequiredError}
|
|
82208
82257
|
*/
|
|
82209
|
-
createNotificationTemplate(templateDtoV2025: TemplateDtoV2025,
|
|
82258
|
+
createNotificationTemplate(templateDtoV2025: TemplateDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2025>>;
|
|
82210
82259
|
/**
|
|
82211
82260
|
* Create a new sender email address and initiate verification process.
|
|
82212
82261
|
* @summary Create verified from address
|
|
82213
82262
|
* @param {EmailStatusDtoV2025} emailStatusDtoV2025
|
|
82214
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82215
82263
|
* @param {*} [axiosOptions] Override http request option.
|
|
82216
82264
|
* @throws {RequiredError}
|
|
82217
82265
|
*/
|
|
82218
|
-
createVerifiedFromAddress(emailStatusDtoV2025: EmailStatusDtoV2025,
|
|
82266
|
+
createVerifiedFromAddress(emailStatusDtoV2025: EmailStatusDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailStatusDtoV2025>>;
|
|
82219
82267
|
/**
|
|
82220
82268
|
* This lets you bulk delete templates that you previously created for your site.
|
|
82221
82269
|
* @summary Bulk delete notification templates
|
|
82222
82270
|
* @param {Array<TemplateBulkDeleteDtoV2025>} templateBulkDeleteDtoV2025
|
|
82223
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82224
82271
|
* @param {*} [axiosOptions] Override http request option.
|
|
82225
82272
|
* @throws {RequiredError}
|
|
82226
82273
|
*/
|
|
82227
|
-
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2025: Array<TemplateBulkDeleteDtoV2025>,
|
|
82274
|
+
deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2025: Array<TemplateBulkDeleteDtoV2025>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82228
82275
|
/**
|
|
82229
82276
|
* Delete a verified sender email address
|
|
82230
82277
|
* @summary Delete verified from address
|
|
82231
|
-
* @param {string} id
|
|
82232
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82278
|
+
* @param {string} id Unique identifier of the verified sender address to delete.
|
|
82233
82279
|
* @param {*} [axiosOptions] Override http request option.
|
|
82234
82280
|
* @throws {RequiredError}
|
|
82235
82281
|
*/
|
|
82236
|
-
deleteVerifiedFromAddress(id: string,
|
|
82282
|
+
deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82237
82283
|
/**
|
|
82238
82284
|
* Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call.
|
|
82239
82285
|
* @summary Get dkim attributes
|
|
82240
|
-
* @param {
|
|
82286
|
+
* @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.
|
|
82287
|
+
* @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.
|
|
82241
82288
|
* @param {*} [axiosOptions] Override http request option.
|
|
82242
82289
|
* @throws {RequiredError}
|
|
82243
82290
|
*/
|
|
82244
|
-
getDkimAttributes(
|
|
82291
|
+
getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DkimAttributesV2025>>>;
|
|
82245
82292
|
/**
|
|
82246
82293
|
* Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
82247
82294
|
* @summary Get mail from attributes
|
|
82248
82295
|
* @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
|
|
82249
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82250
82296
|
* @param {*} [axiosOptions] Override http request option.
|
|
82251
82297
|
* @throws {RequiredError}
|
|
82252
82298
|
*/
|
|
82253
|
-
getMailFromAttributes(identity: string,
|
|
82299
|
+
getMailFromAttributes(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MailFromAttributesV2025>>;
|
|
82300
|
+
/**
|
|
82301
|
+
* Returns a list of notification preferences for tenant.
|
|
82302
|
+
* @summary List notification preferences for tenant.
|
|
82303
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82304
|
+
* @throws {RequiredError}
|
|
82305
|
+
*/
|
|
82306
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferencesDtoV2025>>;
|
|
82254
82307
|
/**
|
|
82255
82308
|
* This gets a template that you have modified for your site by Id.
|
|
82256
82309
|
* @summary Get notification template by id
|
|
82257
82310
|
* @param {string} id Id of the Notification Template
|
|
82258
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82259
82311
|
* @param {*} [axiosOptions] Override http request option.
|
|
82260
82312
|
* @throws {RequiredError}
|
|
82261
82313
|
*/
|
|
82262
|
-
getNotificationTemplate(id: string,
|
|
82314
|
+
getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemplateDtoV2025>>;
|
|
82263
82315
|
/**
|
|
82264
82316
|
* 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).
|
|
82265
82317
|
* @summary Get notification template context
|
|
82266
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82267
82318
|
* @param {*} [axiosOptions] Override http request option.
|
|
82268
82319
|
* @throws {RequiredError}
|
|
82269
82320
|
*/
|
|
82270
|
-
getNotificationsTemplateContext(
|
|
82321
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTemplateContextV2025>>;
|
|
82271
82322
|
/**
|
|
82272
82323
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
82273
82324
|
* @summary List from addresses
|
|
82274
82325
|
* @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.
|
|
82275
82326
|
* @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.
|
|
82276
82327
|
* @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.
|
|
82277
|
-
* @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,
|
|
82328
|
+
* @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*
|
|
82278
82329
|
* @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**
|
|
82279
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82280
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82281
|
-
* @throws {RequiredError}
|
|
82282
|
-
*/
|
|
82283
|
-
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailStatusDtoV2025>>>;
|
|
82284
|
-
/**
|
|
82285
|
-
* Returns a list of notification preferences for tenant.
|
|
82286
|
-
* @summary List notification preferences for tenant.
|
|
82287
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82288
82330
|
* @param {*} [axiosOptions] Override http request option.
|
|
82289
82331
|
* @throws {RequiredError}
|
|
82290
82332
|
*/
|
|
82291
|
-
|
|
82333
|
+
listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmailStatusDtoV2025>>>;
|
|
82292
82334
|
/**
|
|
82293
82335
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
82294
82336
|
* @summary List notification template defaults
|
|
82295
82337
|
* @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.
|
|
82296
82338
|
* @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.
|
|
82297
82339
|
* @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*
|
|
82298
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82299
82340
|
* @param {*} [axiosOptions] Override http request option.
|
|
82300
82341
|
* @throws {RequiredError}
|
|
82301
82342
|
*/
|
|
82302
|
-
listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string,
|
|
82343
|
+
listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoDefaultV2025>>>;
|
|
82303
82344
|
/**
|
|
82304
82345
|
* This lists the templates that you have modified for your site.
|
|
82305
82346
|
* @summary List notification templates
|
|
@@ -82307,29 +82348,26 @@ export declare const NotificationsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
82307
82348
|
* @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.
|
|
82308
82349
|
* @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*
|
|
82309
82350
|
* @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**
|
|
82310
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82311
82351
|
* @param {*} [axiosOptions] Override http request option.
|
|
82312
82352
|
* @throws {RequiredError}
|
|
82313
82353
|
*/
|
|
82314
|
-
listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string,
|
|
82354
|
+
listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoV2025>>>;
|
|
82315
82355
|
/**
|
|
82316
82356
|
* 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
|
|
82317
82357
|
* @summary Change mail from domain
|
|
82318
82358
|
* @param {MailFromAttributesDtoV2025} mailFromAttributesDtoV2025
|
|
82319
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82320
82359
|
* @param {*} [axiosOptions] Override http request option.
|
|
82321
82360
|
* @throws {RequiredError}
|
|
82322
82361
|
*/
|
|
82323
|
-
putMailFromAttributes(mailFromAttributesDtoV2025: MailFromAttributesDtoV2025,
|
|
82362
|
+
putMailFromAttributes(mailFromAttributesDtoV2025: MailFromAttributesDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MailFromAttributesV2025>>;
|
|
82324
82363
|
/**
|
|
82325
82364
|
* Send a Test Notification
|
|
82326
82365
|
* @summary Send test notification
|
|
82327
82366
|
* @param {SendTestNotificationRequestDtoV2025} sendTestNotificationRequestDtoV2025
|
|
82328
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82329
82367
|
* @param {*} [axiosOptions] Override http request option.
|
|
82330
82368
|
* @throws {RequiredError}
|
|
82331
82369
|
*/
|
|
82332
|
-
sendTestNotification(sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025,
|
|
82370
|
+
sendTestNotification(sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82333
82371
|
};
|
|
82334
82372
|
/**
|
|
82335
82373
|
* NotificationsV2025Api - factory interface
|
|
@@ -82392,6 +82430,13 @@ export declare const NotificationsV2025ApiFactory: (configuration?: Configuratio
|
|
|
82392
82430
|
* @throws {RequiredError}
|
|
82393
82431
|
*/
|
|
82394
82432
|
getMailFromAttributes(requestParameters: NotificationsV2025ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MailFromAttributesV2025>;
|
|
82433
|
+
/**
|
|
82434
|
+
* Returns a list of notification preferences for tenant.
|
|
82435
|
+
* @summary List notification preferences for tenant.
|
|
82436
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82437
|
+
* @throws {RequiredError}
|
|
82438
|
+
*/
|
|
82439
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PreferencesDtoV2025>;
|
|
82395
82440
|
/**
|
|
82396
82441
|
* This gets a template that you have modified for your site by Id.
|
|
82397
82442
|
* @summary Get notification template by id
|
|
@@ -82403,11 +82448,10 @@ export declare const NotificationsV2025ApiFactory: (configuration?: Configuratio
|
|
|
82403
82448
|
/**
|
|
82404
82449
|
* 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).
|
|
82405
82450
|
* @summary Get notification template context
|
|
82406
|
-
* @param {NotificationsV2025ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
82407
82451
|
* @param {*} [axiosOptions] Override http request option.
|
|
82408
82452
|
* @throws {RequiredError}
|
|
82409
82453
|
*/
|
|
82410
|
-
getNotificationsTemplateContext(
|
|
82454
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<NotificationTemplateContextV2025>;
|
|
82411
82455
|
/**
|
|
82412
82456
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
82413
82457
|
* @summary List from addresses
|
|
@@ -82416,14 +82460,6 @@ export declare const NotificationsV2025ApiFactory: (configuration?: Configuratio
|
|
|
82416
82460
|
* @throws {RequiredError}
|
|
82417
82461
|
*/
|
|
82418
82462
|
listFromAddresses(requestParameters?: NotificationsV2025ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EmailStatusDtoV2025>>;
|
|
82419
|
-
/**
|
|
82420
|
-
* Returns a list of notification preferences for tenant.
|
|
82421
|
-
* @summary List notification preferences for tenant.
|
|
82422
|
-
* @param {NotificationsV2025ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
82423
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82424
|
-
* @throws {RequiredError}
|
|
82425
|
-
*/
|
|
82426
|
-
listNotificationPreferences(requestParameters?: NotificationsV2025ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PreferencesDtoV2025>;
|
|
82427
82463
|
/**
|
|
82428
82464
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
82429
82465
|
* @summary List notification template defaults
|
|
@@ -82469,12 +82505,6 @@ export interface NotificationsV2025ApiCreateDomainDkimRequest {
|
|
|
82469
82505
|
* @memberof NotificationsV2025ApiCreateDomainDkim
|
|
82470
82506
|
*/
|
|
82471
82507
|
readonly domainAddressV2025: DomainAddressV2025;
|
|
82472
|
-
/**
|
|
82473
|
-
* Use this header to enable this experimental API.
|
|
82474
|
-
* @type {string}
|
|
82475
|
-
* @memberof NotificationsV2025ApiCreateDomainDkim
|
|
82476
|
-
*/
|
|
82477
|
-
readonly xSailPointExperimental?: string;
|
|
82478
82508
|
}
|
|
82479
82509
|
/**
|
|
82480
82510
|
* Request parameters for createNotificationTemplate operation in NotificationsV2025Api.
|
|
@@ -82488,12 +82518,6 @@ export interface NotificationsV2025ApiCreateNotificationTemplateRequest {
|
|
|
82488
82518
|
* @memberof NotificationsV2025ApiCreateNotificationTemplate
|
|
82489
82519
|
*/
|
|
82490
82520
|
readonly templateDtoV2025: TemplateDtoV2025;
|
|
82491
|
-
/**
|
|
82492
|
-
* Use this header to enable this experimental API.
|
|
82493
|
-
* @type {string}
|
|
82494
|
-
* @memberof NotificationsV2025ApiCreateNotificationTemplate
|
|
82495
|
-
*/
|
|
82496
|
-
readonly xSailPointExperimental?: string;
|
|
82497
82521
|
}
|
|
82498
82522
|
/**
|
|
82499
82523
|
* Request parameters for createVerifiedFromAddress operation in NotificationsV2025Api.
|
|
@@ -82507,12 +82531,6 @@ export interface NotificationsV2025ApiCreateVerifiedFromAddressRequest {
|
|
|
82507
82531
|
* @memberof NotificationsV2025ApiCreateVerifiedFromAddress
|
|
82508
82532
|
*/
|
|
82509
82533
|
readonly emailStatusDtoV2025: EmailStatusDtoV2025;
|
|
82510
|
-
/**
|
|
82511
|
-
* Use this header to enable this experimental API.
|
|
82512
|
-
* @type {string}
|
|
82513
|
-
* @memberof NotificationsV2025ApiCreateVerifiedFromAddress
|
|
82514
|
-
*/
|
|
82515
|
-
readonly xSailPointExperimental?: string;
|
|
82516
82534
|
}
|
|
82517
82535
|
/**
|
|
82518
82536
|
* Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2025Api.
|
|
@@ -82526,12 +82544,6 @@ export interface NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
82526
82544
|
* @memberof NotificationsV2025ApiDeleteNotificationTemplatesInBulk
|
|
82527
82545
|
*/
|
|
82528
82546
|
readonly templateBulkDeleteDtoV2025: Array<TemplateBulkDeleteDtoV2025>;
|
|
82529
|
-
/**
|
|
82530
|
-
* Use this header to enable this experimental API.
|
|
82531
|
-
* @type {string}
|
|
82532
|
-
* @memberof NotificationsV2025ApiDeleteNotificationTemplatesInBulk
|
|
82533
|
-
*/
|
|
82534
|
-
readonly xSailPointExperimental?: string;
|
|
82535
82547
|
}
|
|
82536
82548
|
/**
|
|
82537
82549
|
* Request parameters for deleteVerifiedFromAddress operation in NotificationsV2025Api.
|
|
@@ -82540,17 +82552,11 @@ export interface NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest {
|
|
|
82540
82552
|
*/
|
|
82541
82553
|
export interface NotificationsV2025ApiDeleteVerifiedFromAddressRequest {
|
|
82542
82554
|
/**
|
|
82543
|
-
*
|
|
82555
|
+
* Unique identifier of the verified sender address to delete.
|
|
82544
82556
|
* @type {string}
|
|
82545
82557
|
* @memberof NotificationsV2025ApiDeleteVerifiedFromAddress
|
|
82546
82558
|
*/
|
|
82547
82559
|
readonly id: string;
|
|
82548
|
-
/**
|
|
82549
|
-
* Use this header to enable this experimental API.
|
|
82550
|
-
* @type {string}
|
|
82551
|
-
* @memberof NotificationsV2025ApiDeleteVerifiedFromAddress
|
|
82552
|
-
*/
|
|
82553
|
-
readonly xSailPointExperimental?: string;
|
|
82554
82560
|
}
|
|
82555
82561
|
/**
|
|
82556
82562
|
* Request parameters for getDkimAttributes operation in NotificationsV2025Api.
|
|
@@ -82559,11 +82565,17 @@ export interface NotificationsV2025ApiDeleteVerifiedFromAddressRequest {
|
|
|
82559
82565
|
*/
|
|
82560
82566
|
export interface NotificationsV2025ApiGetDkimAttributesRequest {
|
|
82561
82567
|
/**
|
|
82562
|
-
*
|
|
82563
|
-
* @type {
|
|
82568
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82569
|
+
* @type {number}
|
|
82564
82570
|
* @memberof NotificationsV2025ApiGetDkimAttributes
|
|
82565
82571
|
*/
|
|
82566
|
-
readonly
|
|
82572
|
+
readonly limit?: number;
|
|
82573
|
+
/**
|
|
82574
|
+
* 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.
|
|
82575
|
+
* @type {number}
|
|
82576
|
+
* @memberof NotificationsV2025ApiGetDkimAttributes
|
|
82577
|
+
*/
|
|
82578
|
+
readonly offset?: number;
|
|
82567
82579
|
}
|
|
82568
82580
|
/**
|
|
82569
82581
|
* Request parameters for getMailFromAttributes operation in NotificationsV2025Api.
|
|
@@ -82577,12 +82589,6 @@ export interface NotificationsV2025ApiGetMailFromAttributesRequest {
|
|
|
82577
82589
|
* @memberof NotificationsV2025ApiGetMailFromAttributes
|
|
82578
82590
|
*/
|
|
82579
82591
|
readonly identity: string;
|
|
82580
|
-
/**
|
|
82581
|
-
* Use this header to enable this experimental API.
|
|
82582
|
-
* @type {string}
|
|
82583
|
-
* @memberof NotificationsV2025ApiGetMailFromAttributes
|
|
82584
|
-
*/
|
|
82585
|
-
readonly xSailPointExperimental?: string;
|
|
82586
82592
|
}
|
|
82587
82593
|
/**
|
|
82588
82594
|
* Request parameters for getNotificationTemplate operation in NotificationsV2025Api.
|
|
@@ -82596,25 +82602,6 @@ export interface NotificationsV2025ApiGetNotificationTemplateRequest {
|
|
|
82596
82602
|
* @memberof NotificationsV2025ApiGetNotificationTemplate
|
|
82597
82603
|
*/
|
|
82598
82604
|
readonly id: string;
|
|
82599
|
-
/**
|
|
82600
|
-
* Use this header to enable this experimental API.
|
|
82601
|
-
* @type {string}
|
|
82602
|
-
* @memberof NotificationsV2025ApiGetNotificationTemplate
|
|
82603
|
-
*/
|
|
82604
|
-
readonly xSailPointExperimental?: string;
|
|
82605
|
-
}
|
|
82606
|
-
/**
|
|
82607
|
-
* Request parameters for getNotificationsTemplateContext operation in NotificationsV2025Api.
|
|
82608
|
-
* @export
|
|
82609
|
-
* @interface NotificationsV2025ApiGetNotificationsTemplateContextRequest
|
|
82610
|
-
*/
|
|
82611
|
-
export interface NotificationsV2025ApiGetNotificationsTemplateContextRequest {
|
|
82612
|
-
/**
|
|
82613
|
-
* Use this header to enable this experimental API.
|
|
82614
|
-
* @type {string}
|
|
82615
|
-
* @memberof NotificationsV2025ApiGetNotificationsTemplateContext
|
|
82616
|
-
*/
|
|
82617
|
-
readonly xSailPointExperimental?: string;
|
|
82618
82605
|
}
|
|
82619
82606
|
/**
|
|
82620
82607
|
* Request parameters for listFromAddresses operation in NotificationsV2025Api.
|
|
@@ -82641,7 +82628,7 @@ export interface NotificationsV2025ApiListFromAddressesRequest {
|
|
|
82641
82628
|
*/
|
|
82642
82629
|
readonly count?: boolean;
|
|
82643
82630
|
/**
|
|
82644
|
-
* 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,
|
|
82631
|
+
* 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*
|
|
82645
82632
|
* @type {string}
|
|
82646
82633
|
* @memberof NotificationsV2025ApiListFromAddresses
|
|
82647
82634
|
*/
|
|
@@ -82652,25 +82639,6 @@ export interface NotificationsV2025ApiListFromAddressesRequest {
|
|
|
82652
82639
|
* @memberof NotificationsV2025ApiListFromAddresses
|
|
82653
82640
|
*/
|
|
82654
82641
|
readonly sorters?: string;
|
|
82655
|
-
/**
|
|
82656
|
-
* Use this header to enable this experimental API.
|
|
82657
|
-
* @type {string}
|
|
82658
|
-
* @memberof NotificationsV2025ApiListFromAddresses
|
|
82659
|
-
*/
|
|
82660
|
-
readonly xSailPointExperimental?: string;
|
|
82661
|
-
}
|
|
82662
|
-
/**
|
|
82663
|
-
* Request parameters for listNotificationPreferences operation in NotificationsV2025Api.
|
|
82664
|
-
* @export
|
|
82665
|
-
* @interface NotificationsV2025ApiListNotificationPreferencesRequest
|
|
82666
|
-
*/
|
|
82667
|
-
export interface NotificationsV2025ApiListNotificationPreferencesRequest {
|
|
82668
|
-
/**
|
|
82669
|
-
* Use this header to enable this experimental API.
|
|
82670
|
-
* @type {string}
|
|
82671
|
-
* @memberof NotificationsV2025ApiListNotificationPreferences
|
|
82672
|
-
*/
|
|
82673
|
-
readonly xSailPointExperimental?: string;
|
|
82674
82642
|
}
|
|
82675
82643
|
/**
|
|
82676
82644
|
* Request parameters for listNotificationTemplateDefaults operation in NotificationsV2025Api.
|
|
@@ -82696,12 +82664,6 @@ export interface NotificationsV2025ApiListNotificationTemplateDefaultsRequest {
|
|
|
82696
82664
|
* @memberof NotificationsV2025ApiListNotificationTemplateDefaults
|
|
82697
82665
|
*/
|
|
82698
82666
|
readonly filters?: string;
|
|
82699
|
-
/**
|
|
82700
|
-
* Use this header to enable this experimental API.
|
|
82701
|
-
* @type {string}
|
|
82702
|
-
* @memberof NotificationsV2025ApiListNotificationTemplateDefaults
|
|
82703
|
-
*/
|
|
82704
|
-
readonly xSailPointExperimental?: string;
|
|
82705
82667
|
}
|
|
82706
82668
|
/**
|
|
82707
82669
|
* Request parameters for listNotificationTemplates operation in NotificationsV2025Api.
|
|
@@ -82733,12 +82695,6 @@ export interface NotificationsV2025ApiListNotificationTemplatesRequest {
|
|
|
82733
82695
|
* @memberof NotificationsV2025ApiListNotificationTemplates
|
|
82734
82696
|
*/
|
|
82735
82697
|
readonly sorters?: string;
|
|
82736
|
-
/**
|
|
82737
|
-
* Use this header to enable this experimental API.
|
|
82738
|
-
* @type {string}
|
|
82739
|
-
* @memberof NotificationsV2025ApiListNotificationTemplates
|
|
82740
|
-
*/
|
|
82741
|
-
readonly xSailPointExperimental?: string;
|
|
82742
82698
|
}
|
|
82743
82699
|
/**
|
|
82744
82700
|
* Request parameters for putMailFromAttributes operation in NotificationsV2025Api.
|
|
@@ -82752,12 +82708,6 @@ export interface NotificationsV2025ApiPutMailFromAttributesRequest {
|
|
|
82752
82708
|
* @memberof NotificationsV2025ApiPutMailFromAttributes
|
|
82753
82709
|
*/
|
|
82754
82710
|
readonly mailFromAttributesDtoV2025: MailFromAttributesDtoV2025;
|
|
82755
|
-
/**
|
|
82756
|
-
* Use this header to enable this experimental API.
|
|
82757
|
-
* @type {string}
|
|
82758
|
-
* @memberof NotificationsV2025ApiPutMailFromAttributes
|
|
82759
|
-
*/
|
|
82760
|
-
readonly xSailPointExperimental?: string;
|
|
82761
82711
|
}
|
|
82762
82712
|
/**
|
|
82763
82713
|
* Request parameters for sendTestNotification operation in NotificationsV2025Api.
|
|
@@ -82771,12 +82721,6 @@ export interface NotificationsV2025ApiSendTestNotificationRequest {
|
|
|
82771
82721
|
* @memberof NotificationsV2025ApiSendTestNotification
|
|
82772
82722
|
*/
|
|
82773
82723
|
readonly sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025;
|
|
82774
|
-
/**
|
|
82775
|
-
* Use this header to enable this experimental API.
|
|
82776
|
-
* @type {string}
|
|
82777
|
-
* @memberof NotificationsV2025ApiSendTestNotification
|
|
82778
|
-
*/
|
|
82779
|
-
readonly xSailPointExperimental?: string;
|
|
82780
82724
|
}
|
|
82781
82725
|
/**
|
|
82782
82726
|
* NotificationsV2025Api - object-oriented interface
|
|
@@ -82848,6 +82792,14 @@ export declare class NotificationsV2025Api extends BaseAPI {
|
|
|
82848
82792
|
* @memberof NotificationsV2025Api
|
|
82849
82793
|
*/
|
|
82850
82794
|
getMailFromAttributes(requestParameters: NotificationsV2025ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MailFromAttributesV2025, any>>;
|
|
82795
|
+
/**
|
|
82796
|
+
* Returns a list of notification preferences for tenant.
|
|
82797
|
+
* @summary List notification preferences for tenant.
|
|
82798
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82799
|
+
* @throws {RequiredError}
|
|
82800
|
+
* @memberof NotificationsV2025Api
|
|
82801
|
+
*/
|
|
82802
|
+
getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferencesDtoV2025, any>>;
|
|
82851
82803
|
/**
|
|
82852
82804
|
* This gets a template that you have modified for your site by Id.
|
|
82853
82805
|
* @summary Get notification template by id
|
|
@@ -82860,12 +82812,11 @@ export declare class NotificationsV2025Api extends BaseAPI {
|
|
|
82860
82812
|
/**
|
|
82861
82813
|
* 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).
|
|
82862
82814
|
* @summary Get notification template context
|
|
82863
|
-
* @param {NotificationsV2025ApiGetNotificationsTemplateContextRequest} requestParameters Request parameters.
|
|
82864
82815
|
* @param {*} [axiosOptions] Override http request option.
|
|
82865
82816
|
* @throws {RequiredError}
|
|
82866
82817
|
* @memberof NotificationsV2025Api
|
|
82867
82818
|
*/
|
|
82868
|
-
getNotificationsTemplateContext(
|
|
82819
|
+
getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationTemplateContextV2025, any>>;
|
|
82869
82820
|
/**
|
|
82870
82821
|
* Retrieve a list of sender email addresses and their verification statuses
|
|
82871
82822
|
* @summary List from addresses
|
|
@@ -82875,15 +82826,6 @@ export declare class NotificationsV2025Api extends BaseAPI {
|
|
|
82875
82826
|
* @memberof NotificationsV2025Api
|
|
82876
82827
|
*/
|
|
82877
82828
|
listFromAddresses(requestParameters?: NotificationsV2025ApiListFromAddressesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailStatusDtoV2025[], any>>;
|
|
82878
|
-
/**
|
|
82879
|
-
* Returns a list of notification preferences for tenant.
|
|
82880
|
-
* @summary List notification preferences for tenant.
|
|
82881
|
-
* @param {NotificationsV2025ApiListNotificationPreferencesRequest} requestParameters Request parameters.
|
|
82882
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82883
|
-
* @throws {RequiredError}
|
|
82884
|
-
* @memberof NotificationsV2025Api
|
|
82885
|
-
*/
|
|
82886
|
-
listNotificationPreferences(requestParameters?: NotificationsV2025ApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferencesDtoV2025, any>>;
|
|
82887
82829
|
/**
|
|
82888
82830
|
* This lists the default templates used for notifications, such as emails from IdentityNow.
|
|
82889
82831
|
* @summary List notification template defaults
|