sailpoint-api-client 1.6.9 → 1.7.0
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 +264 -550
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +248 -392
- package/dist/beta/api.js +104 -416
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +18 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/v2024/api.d.ts +123 -361
- package/dist/v2024/api.js +93 -410
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +1643 -412
- package/dist/v2025/api.js +2844 -1167
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v2026/api.d.ts +810 -0
- package/dist/v2026/api.js +792 -0
- package/dist/v2026/api.js.map +1 -0
- package/dist/v2026/base.d.ts +66 -0
- package/dist/v2026/base.js +89 -0
- package/dist/v2026/base.js.map +1 -0
- package/dist/v2026/common.d.ts +65 -0
- package/dist/v2026/common.js +266 -0
- package/dist/v2026/common.js.map +1 -0
- package/dist/v2026/configuration.d.ts +91 -0
- package/dist/v2026/configuration.js +46 -0
- package/dist/v2026/configuration.js.map +1 -0
- package/dist/v2026/index.d.ts +13 -0
- package/dist/v2026/index.js +32 -0
- package/dist/v2026/index.js.map +1 -0
- package/dist/v3/api.d.ts +85 -365
- package/dist/v3/api.js +67 -383
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/index.spec.ts +11 -1
- package/index.ts +3 -0
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +134 -517
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +2816 -770
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/.openapi-generator/FILES +12 -0
- package/v2026/.openapi-generator/VERSION +1 -0
- package/v2026/.openapi-generator-ignore +23 -0
- package/v2026/README.md +46 -0
- package/v2026/api.ts +1180 -0
- package/v2026/base.ts +86 -0
- package/v2026/common.ts +165 -0
- package/v2026/configuration.ts +110 -0
- package/v2026/git_push.sh +57 -0
- package/v2026/index.ts +18 -0
- package/v2026/package.json +34 -0
- package/v2026/tsconfig.json +21 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +93 -518
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2025/api.d.ts
CHANGED
|
@@ -1065,13 +1065,13 @@ export interface AccessModelMetadataValuesInnerV2025 {
|
|
|
1065
1065
|
*/
|
|
1066
1066
|
export interface AccessProfileApprovalSchemeV2025 {
|
|
1067
1067
|
/**
|
|
1068
|
-
* Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
1068
|
+
* Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required.
|
|
1069
1069
|
* @type {string}
|
|
1070
1070
|
* @memberof AccessProfileApprovalSchemeV2025
|
|
1071
1071
|
*/
|
|
1072
1072
|
'approverType'?: AccessProfileApprovalSchemeV2025ApproverTypeV2025;
|
|
1073
1073
|
/**
|
|
1074
|
-
*
|
|
1074
|
+
* Id of the specific approver, used when approverType is GOVERNANCE_GROUP or WORKFLOW.
|
|
1075
1075
|
* @type {string}
|
|
1076
1076
|
* @memberof AccessProfileApprovalSchemeV2025
|
|
1077
1077
|
*/
|
|
@@ -1083,6 +1083,7 @@ export declare const AccessProfileApprovalSchemeV2025ApproverTypeV2025: {
|
|
|
1083
1083
|
readonly SourceOwner: "SOURCE_OWNER";
|
|
1084
1084
|
readonly Manager: "MANAGER";
|
|
1085
1085
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
1086
|
+
readonly Workflow: "WORKFLOW";
|
|
1086
1087
|
};
|
|
1087
1088
|
export type AccessProfileApprovalSchemeV2025ApproverTypeV2025 = typeof AccessProfileApprovalSchemeV2025ApproverTypeV2025[keyof typeof AccessProfileApprovalSchemeV2025ApproverTypeV2025];
|
|
1088
1089
|
/**
|
|
@@ -3340,7 +3341,7 @@ export interface AccessV2025 {
|
|
|
3340
3341
|
*/
|
|
3341
3342
|
export interface AccountActionV2025 {
|
|
3342
3343
|
/**
|
|
3343
|
-
* Describes if action will be
|
|
3344
|
+
* Describes if action will be enable, disable or delete.
|
|
3344
3345
|
* @type {string}
|
|
3345
3346
|
* @memberof AccountActionV2025
|
|
3346
3347
|
*/
|
|
@@ -3367,6 +3368,7 @@ export interface AccountActionV2025 {
|
|
|
3367
3368
|
export declare const AccountActionV2025ActionV2025: {
|
|
3368
3369
|
readonly Enable: "ENABLE";
|
|
3369
3370
|
readonly Disable: "DISABLE";
|
|
3371
|
+
readonly Delete: "DELETE";
|
|
3370
3372
|
};
|
|
3371
3373
|
export type AccountActionV2025ActionV2025 = typeof AccountActionV2025ActionV2025[keyof typeof AccountActionV2025ActionV2025];
|
|
3372
3374
|
/**
|
|
@@ -6330,7 +6332,7 @@ export interface ApprovalConfigV2025 {
|
|
|
6330
6332
|
*/
|
|
6331
6333
|
'id'?: string;
|
|
6332
6334
|
/**
|
|
6333
|
-
* The type/scope of the configuration. Ie
|
|
6335
|
+
* The type/scope of the configuration. Ie DOMAIN_OBJECT, APPROVAL_TYPE, TENANT
|
|
6334
6336
|
* @type {string}
|
|
6335
6337
|
* @memberof ApprovalConfigV2025
|
|
6336
6338
|
*/
|
|
@@ -6981,13 +6983,13 @@ export interface ApprovalRequestedTargetV2025 {
|
|
|
6981
6983
|
*/
|
|
6982
6984
|
export interface ApprovalSchemeForRoleV2025 {
|
|
6983
6985
|
/**
|
|
6984
|
-
* Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
6986
|
+
* Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required.
|
|
6985
6987
|
* @type {string}
|
|
6986
6988
|
* @memberof ApprovalSchemeForRoleV2025
|
|
6987
6989
|
*/
|
|
6988
6990
|
'approverType'?: ApprovalSchemeForRoleV2025ApproverTypeV2025;
|
|
6989
6991
|
/**
|
|
6990
|
-
* Id of the specific approver, used
|
|
6992
|
+
* Id of the specific approver, used when approverType is GOVERNANCE_GROUP or WORKFLOW.
|
|
6991
6993
|
* @type {string}
|
|
6992
6994
|
* @memberof ApprovalSchemeForRoleV2025
|
|
6993
6995
|
*/
|
|
@@ -6997,6 +6999,7 @@ export declare const ApprovalSchemeForRoleV2025ApproverTypeV2025: {
|
|
|
6997
6999
|
readonly Owner: "OWNER";
|
|
6998
7000
|
readonly Manager: "MANAGER";
|
|
6999
7001
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
7002
|
+
readonly Workflow: "WORKFLOW";
|
|
7000
7003
|
};
|
|
7001
7004
|
export type ApprovalSchemeForRoleV2025ApproverTypeV2025 = typeof ApprovalSchemeForRoleV2025ApproverTypeV2025[keyof typeof ApprovalSchemeForRoleV2025ApproverTypeV2025];
|
|
7002
7005
|
/**
|
|
@@ -7650,6 +7653,12 @@ export interface AttributeDefinitionV2025 {
|
|
|
7650
7653
|
* @memberof AttributeDefinitionV2025
|
|
7651
7654
|
*/
|
|
7652
7655
|
'name'?: string;
|
|
7656
|
+
/**
|
|
7657
|
+
* Attribute name in the native system.
|
|
7658
|
+
* @type {string}
|
|
7659
|
+
* @memberof AttributeDefinitionV2025
|
|
7660
|
+
*/
|
|
7661
|
+
'nativeName'?: string | null;
|
|
7653
7662
|
/**
|
|
7654
7663
|
*
|
|
7655
7664
|
* @type {AttributeDefinitionTypeV2025}
|
|
@@ -8010,6 +8019,56 @@ export declare const AuthProfileV2025TypeV2025: {
|
|
|
8010
8019
|
readonly Pta: "PTA";
|
|
8011
8020
|
};
|
|
8012
8021
|
export type AuthProfileV2025TypeV2025 = typeof AuthProfileV2025TypeV2025[keyof typeof AuthProfileV2025TypeV2025];
|
|
8022
|
+
/**
|
|
8023
|
+
*
|
|
8024
|
+
* @export
|
|
8025
|
+
* @interface AuthUserLevelsIdentityCountV2025
|
|
8026
|
+
*/
|
|
8027
|
+
export interface AuthUserLevelsIdentityCountV2025 {
|
|
8028
|
+
/**
|
|
8029
|
+
* The unique identifier of the user level.
|
|
8030
|
+
* @type {string}
|
|
8031
|
+
* @memberof AuthUserLevelsIdentityCountV2025
|
|
8032
|
+
*/
|
|
8033
|
+
'id'?: string;
|
|
8034
|
+
/**
|
|
8035
|
+
* Number of identities having this user level.
|
|
8036
|
+
* @type {number}
|
|
8037
|
+
* @memberof AuthUserLevelsIdentityCountV2025
|
|
8038
|
+
*/
|
|
8039
|
+
'count'?: number;
|
|
8040
|
+
}
|
|
8041
|
+
/**
|
|
8042
|
+
*
|
|
8043
|
+
* @export
|
|
8044
|
+
* @interface AuthUserSlimResponseV2025
|
|
8045
|
+
*/
|
|
8046
|
+
export interface AuthUserSlimResponseV2025 {
|
|
8047
|
+
/**
|
|
8048
|
+
* Identity ID.
|
|
8049
|
+
* @type {string}
|
|
8050
|
+
* @memberof AuthUserSlimResponseV2025
|
|
8051
|
+
*/
|
|
8052
|
+
'id'?: string;
|
|
8053
|
+
/**
|
|
8054
|
+
* Identity unique identifier.
|
|
8055
|
+
* @type {string}
|
|
8056
|
+
* @memberof AuthUserSlimResponseV2025
|
|
8057
|
+
*/
|
|
8058
|
+
'uid'?: string;
|
|
8059
|
+
/**
|
|
8060
|
+
* Identity alias.
|
|
8061
|
+
* @type {string}
|
|
8062
|
+
* @memberof AuthUserSlimResponseV2025
|
|
8063
|
+
*/
|
|
8064
|
+
'alias'?: string;
|
|
8065
|
+
/**
|
|
8066
|
+
* Identity name in display format.
|
|
8067
|
+
* @type {string}
|
|
8068
|
+
* @memberof AuthUserSlimResponseV2025
|
|
8069
|
+
*/
|
|
8070
|
+
'displayName'?: string;
|
|
8071
|
+
}
|
|
8013
8072
|
/**
|
|
8014
8073
|
*
|
|
8015
8074
|
* @export
|
|
@@ -9195,6 +9254,33 @@ export interface BulkApproveAccessRequestV2025 {
|
|
|
9195
9254
|
*/
|
|
9196
9255
|
'comment': string;
|
|
9197
9256
|
}
|
|
9257
|
+
/**
|
|
9258
|
+
* BulkApproveRequestDTO is the input struct that represents the request body required to facilitate a bulk approval action for a set of generic approval requests.
|
|
9259
|
+
* @export
|
|
9260
|
+
* @interface BulkApproveRequestDTOV2025
|
|
9261
|
+
*/
|
|
9262
|
+
export interface BulkApproveRequestDTOV2025 {
|
|
9263
|
+
/**
|
|
9264
|
+
* Array of Approval IDs to be bulk approved
|
|
9265
|
+
* @type {Array<string>}
|
|
9266
|
+
* @memberof BulkApproveRequestDTOV2025
|
|
9267
|
+
*/
|
|
9268
|
+
'approvalIds'?: Array<string>;
|
|
9269
|
+
/**
|
|
9270
|
+
* Optional comment to include with the bulk approval request
|
|
9271
|
+
* @type {string}
|
|
9272
|
+
* @memberof BulkApproveRequestDTOV2025
|
|
9273
|
+
*/
|
|
9274
|
+
'comment'?: string;
|
|
9275
|
+
/**
|
|
9276
|
+
* Additional attributes to include with the bulk approval request
|
|
9277
|
+
* @type {{ [key: string]: object; }}
|
|
9278
|
+
* @memberof BulkApproveRequestDTOV2025
|
|
9279
|
+
*/
|
|
9280
|
+
'additionalAttributes'?: {
|
|
9281
|
+
[key: string]: object;
|
|
9282
|
+
};
|
|
9283
|
+
}
|
|
9198
9284
|
/**
|
|
9199
9285
|
* Request body payload for bulk cancel access request endpoint.
|
|
9200
9286
|
* @export
|
|
@@ -9214,6 +9300,25 @@ export interface BulkCancelAccessRequestV2025 {
|
|
|
9214
9300
|
*/
|
|
9215
9301
|
'comment': string;
|
|
9216
9302
|
}
|
|
9303
|
+
/**
|
|
9304
|
+
* BulkCancelRequestDTO is the input struct that represents the request body required to facilitate a bulk cancellation action for a set of generic approval requests.
|
|
9305
|
+
* @export
|
|
9306
|
+
* @interface BulkCancelRequestDTOV2025
|
|
9307
|
+
*/
|
|
9308
|
+
export interface BulkCancelRequestDTOV2025 {
|
|
9309
|
+
/**
|
|
9310
|
+
* Array of Approval IDs to be bulk cancelled
|
|
9311
|
+
* @type {Array<string>}
|
|
9312
|
+
* @memberof BulkCancelRequestDTOV2025
|
|
9313
|
+
*/
|
|
9314
|
+
'approvalIds'?: Array<string>;
|
|
9315
|
+
/**
|
|
9316
|
+
* Optional comment to include with the bulk cancellation request
|
|
9317
|
+
* @type {string}
|
|
9318
|
+
* @memberof BulkCancelRequestDTOV2025
|
|
9319
|
+
*/
|
|
9320
|
+
'comment'?: string;
|
|
9321
|
+
}
|
|
9217
9322
|
/**
|
|
9218
9323
|
* Bulk response object.
|
|
9219
9324
|
* @export
|
|
@@ -9239,6 +9344,56 @@ export interface BulkIdentitiesAccountsResponseV2025 {
|
|
|
9239
9344
|
*/
|
|
9240
9345
|
'message'?: string;
|
|
9241
9346
|
}
|
|
9347
|
+
/**
|
|
9348
|
+
* BulkReassignRequestDTO is the input struct that represents the request body required to facilitate a bulk reassignment action for a set of generic approval requests.
|
|
9349
|
+
* @export
|
|
9350
|
+
* @interface BulkReassignRequestDTOV2025
|
|
9351
|
+
*/
|
|
9352
|
+
export interface BulkReassignRequestDTOV2025 {
|
|
9353
|
+
/**
|
|
9354
|
+
* Array of Approval IDs to be bulk reassigned
|
|
9355
|
+
* @type {Array<string>}
|
|
9356
|
+
* @memberof BulkReassignRequestDTOV2025
|
|
9357
|
+
*/
|
|
9358
|
+
'approvalIds'?: Array<string>;
|
|
9359
|
+
/**
|
|
9360
|
+
* Optional comment to include with the bulk reassignment request
|
|
9361
|
+
* @type {string}
|
|
9362
|
+
* @memberof BulkReassignRequestDTOV2025
|
|
9363
|
+
*/
|
|
9364
|
+
'comment'?: string;
|
|
9365
|
+
/**
|
|
9366
|
+
* Identity ID from which the approval requests are being reassigned
|
|
9367
|
+
* @type {string}
|
|
9368
|
+
* @memberof BulkReassignRequestDTOV2025
|
|
9369
|
+
*/
|
|
9370
|
+
'reassignFrom'?: string;
|
|
9371
|
+
/**
|
|
9372
|
+
* ReassignTo signifies the Identity ID that the approval request is being reassigned to
|
|
9373
|
+
* @type {string}
|
|
9374
|
+
* @memberof BulkReassignRequestDTOV2025
|
|
9375
|
+
*/
|
|
9376
|
+
'reassignTo'?: string;
|
|
9377
|
+
}
|
|
9378
|
+
/**
|
|
9379
|
+
* BulkRejectRequestDTO is the input struct that represents the request body required to facilitate a bulk reject action for a set of generic approval requests.
|
|
9380
|
+
* @export
|
|
9381
|
+
* @interface BulkRejectRequestDTOV2025
|
|
9382
|
+
*/
|
|
9383
|
+
export interface BulkRejectRequestDTOV2025 {
|
|
9384
|
+
/**
|
|
9385
|
+
* Array of Approval IDs to be bulk rejected
|
|
9386
|
+
* @type {Array<string>}
|
|
9387
|
+
* @memberof BulkRejectRequestDTOV2025
|
|
9388
|
+
*/
|
|
9389
|
+
'approvalIds'?: Array<string>;
|
|
9390
|
+
/**
|
|
9391
|
+
* Optional comment to include with the bulk reject request
|
|
9392
|
+
* @type {string}
|
|
9393
|
+
* @memberof BulkRejectRequestDTOV2025
|
|
9394
|
+
*/
|
|
9395
|
+
'comment'?: string;
|
|
9396
|
+
}
|
|
9242
9397
|
/**
|
|
9243
9398
|
*
|
|
9244
9399
|
* @export
|
|
@@ -12000,6 +12155,12 @@ export interface CompletedApprovalV2025 {
|
|
|
12000
12155
|
* @memberof CompletedApprovalV2025
|
|
12001
12156
|
*/
|
|
12002
12157
|
'requestedAccounts'?: Array<RequestedAccountRefV2025> | null;
|
|
12158
|
+
/**
|
|
12159
|
+
* The privilege level of the requested access item, if applicable.
|
|
12160
|
+
* @type {string}
|
|
12161
|
+
* @memberof CompletedApprovalV2025
|
|
12162
|
+
*/
|
|
12163
|
+
'privilegeLevel'?: string | null;
|
|
12003
12164
|
}
|
|
12004
12165
|
/**
|
|
12005
12166
|
* The status after completion.
|
|
@@ -12242,6 +12403,7 @@ export declare const ConfigTypeEnumV2025: {
|
|
|
12242
12403
|
readonly AccessRequests: "ACCESS_REQUESTS";
|
|
12243
12404
|
readonly Certifications: "CERTIFICATIONS";
|
|
12244
12405
|
readonly ManualTasks: "MANUAL_TASKS";
|
|
12406
|
+
readonly GenericApprovals: "GENERIC_APPROVALS";
|
|
12245
12407
|
};
|
|
12246
12408
|
export type ConfigTypeEnumV2025 = typeof ConfigTypeEnumV2025[keyof typeof ConfigTypeEnumV2025];
|
|
12247
12409
|
/**
|
|
@@ -14318,19 +14480,6 @@ export declare const DeleteSource202ResponseV2025TypeV2025: {
|
|
|
14318
14480
|
readonly TaskResult: "TASK_RESULT";
|
|
14319
14481
|
};
|
|
14320
14482
|
export type DeleteSource202ResponseV2025TypeV2025 = typeof DeleteSource202ResponseV2025TypeV2025[keyof typeof DeleteSource202ResponseV2025TypeV2025];
|
|
14321
|
-
/**
|
|
14322
|
-
*
|
|
14323
|
-
* @export
|
|
14324
|
-
* @interface DeleteVendorConnectorMapping200ResponseV2025
|
|
14325
|
-
*/
|
|
14326
|
-
export interface DeleteVendorConnectorMapping200ResponseV2025 {
|
|
14327
|
-
/**
|
|
14328
|
-
* The number of vendor connector mappings successfully deleted.
|
|
14329
|
-
* @type {number}
|
|
14330
|
-
* @memberof DeleteVendorConnectorMapping200ResponseV2025
|
|
14331
|
-
*/
|
|
14332
|
-
'count'?: number;
|
|
14333
|
-
}
|
|
14334
14483
|
/**
|
|
14335
14484
|
*
|
|
14336
14485
|
* @export
|
|
@@ -14574,6 +14723,31 @@ export declare const DeployResponseV2025CloudStorageStatusV2025: {
|
|
|
14574
14723
|
readonly SyncFailed: "SYNC_FAILED";
|
|
14575
14724
|
};
|
|
14576
14725
|
export type DeployResponseV2025CloudStorageStatusV2025 = typeof DeployResponseV2025CloudStorageStatusV2025[keyof typeof DeployResponseV2025CloudStorageStatusV2025];
|
|
14726
|
+
/**
|
|
14727
|
+
* A dimension attribute
|
|
14728
|
+
* @export
|
|
14729
|
+
* @interface DimensionAttributeV2025
|
|
14730
|
+
*/
|
|
14731
|
+
export interface DimensionAttributeV2025 {
|
|
14732
|
+
/**
|
|
14733
|
+
* Name of the attribute
|
|
14734
|
+
* @type {string}
|
|
14735
|
+
* @memberof DimensionAttributeV2025
|
|
14736
|
+
*/
|
|
14737
|
+
'name'?: string;
|
|
14738
|
+
/**
|
|
14739
|
+
* Display name of the attribute
|
|
14740
|
+
* @type {string}
|
|
14741
|
+
* @memberof DimensionAttributeV2025
|
|
14742
|
+
*/
|
|
14743
|
+
'displayName'?: string;
|
|
14744
|
+
/**
|
|
14745
|
+
* If an attribute is derived, its value comes from the identity. Otherwise, it can be provided with access request
|
|
14746
|
+
* @type {boolean}
|
|
14747
|
+
* @memberof DimensionAttributeV2025
|
|
14748
|
+
*/
|
|
14749
|
+
'derived'?: boolean;
|
|
14750
|
+
}
|
|
14577
14751
|
/**
|
|
14578
14752
|
*
|
|
14579
14753
|
* @export
|
|
@@ -14770,6 +14944,19 @@ export declare const DimensionRefV2025TypeV2025: {
|
|
|
14770
14944
|
readonly Dimension: "DIMENSION";
|
|
14771
14945
|
};
|
|
14772
14946
|
export type DimensionRefV2025TypeV2025 = typeof DimensionRefV2025TypeV2025[keyof typeof DimensionRefV2025TypeV2025];
|
|
14947
|
+
/**
|
|
14948
|
+
* Contains a list of dimension attributes. Required only for Dynamic Roles
|
|
14949
|
+
* @export
|
|
14950
|
+
* @interface DimensionSchemaV2025
|
|
14951
|
+
*/
|
|
14952
|
+
export interface DimensionSchemaV2025 {
|
|
14953
|
+
/**
|
|
14954
|
+
*
|
|
14955
|
+
* @type {Array<DimensionAttributeV2025>}
|
|
14956
|
+
* @memberof DimensionSchemaV2025
|
|
14957
|
+
*/
|
|
14958
|
+
'dimensionAttributes'?: Array<DimensionAttributeV2025>;
|
|
14959
|
+
}
|
|
14773
14960
|
/**
|
|
14774
14961
|
* A Dimension
|
|
14775
14962
|
* @export
|
|
@@ -15311,13 +15498,13 @@ export interface EntitlementAccessRequestConfigV2025 {
|
|
|
15311
15498
|
*/
|
|
15312
15499
|
export interface EntitlementApprovalSchemeV2025 {
|
|
15313
15500
|
/**
|
|
15314
|
-
* Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
15501
|
+
* Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required.
|
|
15315
15502
|
* @type {string}
|
|
15316
15503
|
* @memberof EntitlementApprovalSchemeV2025
|
|
15317
15504
|
*/
|
|
15318
15505
|
'approverType'?: EntitlementApprovalSchemeV2025ApproverTypeV2025;
|
|
15319
15506
|
/**
|
|
15320
|
-
* Id of the specific approver, used only when approverType is GOVERNANCE_GROUP
|
|
15507
|
+
* Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW
|
|
15321
15508
|
* @type {string}
|
|
15322
15509
|
* @memberof EntitlementApprovalSchemeV2025
|
|
15323
15510
|
*/
|
|
@@ -15328,6 +15515,7 @@ export declare const EntitlementApprovalSchemeV2025ApproverTypeV2025: {
|
|
|
15328
15515
|
readonly SourceOwner: "SOURCE_OWNER";
|
|
15329
15516
|
readonly Manager: "MANAGER";
|
|
15330
15517
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
15518
|
+
readonly Workflow: "WORKFLOW";
|
|
15331
15519
|
};
|
|
15332
15520
|
export type EntitlementApprovalSchemeV2025ApproverTypeV2025 = typeof EntitlementApprovalSchemeV2025ApproverTypeV2025[keyof typeof EntitlementApprovalSchemeV2025ApproverTypeV2025];
|
|
15333
15521
|
/**
|
|
@@ -17462,11 +17650,11 @@ export interface FieldDetailsDtoV2025 {
|
|
|
17462
17650
|
*/
|
|
17463
17651
|
'isRequired'?: boolean;
|
|
17464
17652
|
/**
|
|
17465
|
-
* The type of the attribute.
|
|
17653
|
+
* The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted.
|
|
17466
17654
|
* @type {string}
|
|
17467
17655
|
* @memberof FieldDetailsDtoV2025
|
|
17468
17656
|
*/
|
|
17469
|
-
'type'?:
|
|
17657
|
+
'type'?: FieldDetailsDtoV2025TypeV2025;
|
|
17470
17658
|
/**
|
|
17471
17659
|
* Flag indicating whether or not the attribute is multi-valued.
|
|
17472
17660
|
* @type {boolean}
|
|
@@ -17474,6 +17662,15 @@ export interface FieldDetailsDtoV2025 {
|
|
|
17474
17662
|
*/
|
|
17475
17663
|
'isMultiValued'?: boolean;
|
|
17476
17664
|
}
|
|
17665
|
+
export declare const FieldDetailsDtoV2025TypeV2025: {
|
|
17666
|
+
readonly String: "string";
|
|
17667
|
+
readonly Int: "int";
|
|
17668
|
+
readonly Long: "long";
|
|
17669
|
+
readonly Date: "date";
|
|
17670
|
+
readonly Boolean: "boolean";
|
|
17671
|
+
readonly Secret: "secret";
|
|
17672
|
+
};
|
|
17673
|
+
export type FieldDetailsDtoV2025TypeV2025 = typeof FieldDetailsDtoV2025TypeV2025[keyof typeof FieldDetailsDtoV2025TypeV2025];
|
|
17477
17674
|
/**
|
|
17478
17675
|
* An additional filter to constrain the results of the search query.
|
|
17479
17676
|
* @export
|
|
@@ -19175,6 +19372,12 @@ export interface GetRoleAssignments200ResponseInnerV2025 {
|
|
|
19175
19372
|
* @memberof GetRoleAssignments200ResponseInnerV2025
|
|
19176
19373
|
*/
|
|
19177
19374
|
'role'?: BaseReferenceDtoV2025;
|
|
19375
|
+
/**
|
|
19376
|
+
* Date that the assignment was added
|
|
19377
|
+
* @type {string}
|
|
19378
|
+
* @memberof GetRoleAssignments200ResponseInnerV2025
|
|
19379
|
+
*/
|
|
19380
|
+
'addedDate'?: string;
|
|
19178
19381
|
/**
|
|
19179
19382
|
* Comments added by the user when the assignment was made
|
|
19180
19383
|
* @type {string}
|
|
@@ -22894,7 +23097,7 @@ export interface LifecycleStateV2025 {
|
|
|
22894
23097
|
*/
|
|
22895
23098
|
'accessActionConfiguration'?: AccessActionConfigurationV2025;
|
|
22896
23099
|
/**
|
|
22897
|
-
*
|
|
23100
|
+
* Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10.
|
|
22898
23101
|
* @type {number}
|
|
22899
23102
|
* @memberof LifecycleStateV2025
|
|
22900
23103
|
*/
|
|
@@ -26811,6 +27014,7 @@ export declare const MultiHostIntegrationsV2025FeaturesV2025: {
|
|
|
26811
27014
|
readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT";
|
|
26812
27015
|
readonly UsesUuid: "USES_UUID";
|
|
26813
27016
|
readonly ApplicationDiscovery: "APPLICATION_DISCOVERY";
|
|
27017
|
+
readonly Delete: "DELETE";
|
|
26814
27018
|
};
|
|
26815
27019
|
export type MultiHostIntegrationsV2025FeaturesV2025 = typeof MultiHostIntegrationsV2025FeaturesV2025[keyof typeof MultiHostIntegrationsV2025FeaturesV2025];
|
|
26816
27020
|
export declare const MultiHostIntegrationsV2025StatusV2025: {
|
|
@@ -27060,6 +27264,7 @@ export declare const MultiHostSourcesV2025FeaturesV2025: {
|
|
|
27060
27264
|
readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT";
|
|
27061
27265
|
readonly UsesUuid: "USES_UUID";
|
|
27062
27266
|
readonly ApplicationDiscovery: "APPLICATION_DISCOVERY";
|
|
27267
|
+
readonly Delete: "DELETE";
|
|
27063
27268
|
};
|
|
27064
27269
|
export type MultiHostSourcesV2025FeaturesV2025 = typeof MultiHostSourcesV2025FeaturesV2025[keyof typeof MultiHostSourcesV2025FeaturesV2025];
|
|
27065
27270
|
export declare const MultiHostSourcesV2025StatusV2025: {
|
|
@@ -29386,6 +29591,249 @@ export interface OwnsV2025 {
|
|
|
29386
29591
|
*/
|
|
29387
29592
|
'fallbackApprover'?: boolean;
|
|
29388
29593
|
}
|
|
29594
|
+
/**
|
|
29595
|
+
* The attestation document. This is Base64Url encoded binary data containing the attestation document. This has a cert with a public key that needs to be used to encrypt the private fields of the parameter on creation or update.
|
|
29596
|
+
* @export
|
|
29597
|
+
* @interface ParameterStorageAttestationDocumentV2025
|
|
29598
|
+
*/
|
|
29599
|
+
export interface ParameterStorageAttestationDocumentV2025 {
|
|
29600
|
+
/**
|
|
29601
|
+
* The Base64Url encoded attestation document.
|
|
29602
|
+
* @type {string}
|
|
29603
|
+
* @memberof ParameterStorageAttestationDocumentV2025
|
|
29604
|
+
*/
|
|
29605
|
+
'attestationDocument'?: string;
|
|
29606
|
+
}
|
|
29607
|
+
/**
|
|
29608
|
+
* RFC 6902 JSON Patch operation
|
|
29609
|
+
* @export
|
|
29610
|
+
* @interface ParameterStorageJsonPatchV2025
|
|
29611
|
+
*/
|
|
29612
|
+
export interface ParameterStorageJsonPatchV2025 {
|
|
29613
|
+
/**
|
|
29614
|
+
* The operation to perform (add, remove, replace, move, copy, test)
|
|
29615
|
+
* @type {string}
|
|
29616
|
+
* @memberof ParameterStorageJsonPatchV2025
|
|
29617
|
+
*/
|
|
29618
|
+
'op': ParameterStorageJsonPatchV2025OpV2025;
|
|
29619
|
+
/**
|
|
29620
|
+
* A JSON-Pointer describing the target location
|
|
29621
|
+
* @type {string}
|
|
29622
|
+
* @memberof ParameterStorageJsonPatchV2025
|
|
29623
|
+
*/
|
|
29624
|
+
'path': string;
|
|
29625
|
+
/**
|
|
29626
|
+
* The value to be used within the operations. Required for add/replace/test.
|
|
29627
|
+
* @type {object}
|
|
29628
|
+
* @memberof ParameterStorageJsonPatchV2025
|
|
29629
|
+
*/
|
|
29630
|
+
'value'?: object;
|
|
29631
|
+
/**
|
|
29632
|
+
* A JSON-Pointer describing the source location for move/copy.
|
|
29633
|
+
* @type {string}
|
|
29634
|
+
* @memberof ParameterStorageJsonPatchV2025
|
|
29635
|
+
*/
|
|
29636
|
+
'from'?: string;
|
|
29637
|
+
}
|
|
29638
|
+
export declare const ParameterStorageJsonPatchV2025OpV2025: {
|
|
29639
|
+
readonly Add: "add";
|
|
29640
|
+
readonly Remove: "remove";
|
|
29641
|
+
readonly Replace: "replace";
|
|
29642
|
+
readonly Move: "move";
|
|
29643
|
+
readonly Copy: "copy";
|
|
29644
|
+
readonly Test: "test";
|
|
29645
|
+
};
|
|
29646
|
+
export type ParameterStorageJsonPatchV2025OpV2025 = typeof ParameterStorageJsonPatchV2025OpV2025[keyof typeof ParameterStorageJsonPatchV2025OpV2025];
|
|
29647
|
+
/**
|
|
29648
|
+
* A parameter to add to parameter storage. The public and private fields must match the type specification.
|
|
29649
|
+
* @export
|
|
29650
|
+
* @interface ParameterStorageNewParameterV2025
|
|
29651
|
+
*/
|
|
29652
|
+
export interface ParameterStorageNewParameterV2025 {
|
|
29653
|
+
/**
|
|
29654
|
+
* The UUID of the parameter owner.
|
|
29655
|
+
* @type {string}
|
|
29656
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29657
|
+
*/
|
|
29658
|
+
'ownerId': string;
|
|
29659
|
+
/**
|
|
29660
|
+
* The human-readable name for the parameter.
|
|
29661
|
+
* @type {string}
|
|
29662
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29663
|
+
*/
|
|
29664
|
+
'name': string;
|
|
29665
|
+
/**
|
|
29666
|
+
* The type of the parameter. This cannot be changed after being set. Please see the types document for more information.
|
|
29667
|
+
* @type {string}
|
|
29668
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29669
|
+
*/
|
|
29670
|
+
'type': string;
|
|
29671
|
+
/**
|
|
29672
|
+
* The content must be a JSON object containing the public fields that can be stored with this parameter.
|
|
29673
|
+
* @type {object}
|
|
29674
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29675
|
+
*/
|
|
29676
|
+
'publicFields'?: object;
|
|
29677
|
+
/**
|
|
29678
|
+
* Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter.
|
|
29679
|
+
* @type {string}
|
|
29680
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29681
|
+
*/
|
|
29682
|
+
'privateFields'?: string;
|
|
29683
|
+
/**
|
|
29684
|
+
* Describe the parameter
|
|
29685
|
+
* @type {string}
|
|
29686
|
+
* @memberof ParameterStorageNewParameterV2025
|
|
29687
|
+
*/
|
|
29688
|
+
'description'?: string;
|
|
29689
|
+
}
|
|
29690
|
+
/**
|
|
29691
|
+
* A parameter that has been retrieved from the store.
|
|
29692
|
+
* @export
|
|
29693
|
+
* @interface ParameterStorageParameterV2025
|
|
29694
|
+
*/
|
|
29695
|
+
export interface ParameterStorageParameterV2025 {
|
|
29696
|
+
/**
|
|
29697
|
+
* The ID of the reference
|
|
29698
|
+
* @type {string}
|
|
29699
|
+
* @memberof ParameterStorageParameterV2025
|
|
29700
|
+
*/
|
|
29701
|
+
'id': string;
|
|
29702
|
+
/**
|
|
29703
|
+
* The ID of the user who owns the parameter.
|
|
29704
|
+
* @type {string}
|
|
29705
|
+
* @memberof ParameterStorageParameterV2025
|
|
29706
|
+
*/
|
|
29707
|
+
'ownerId': string;
|
|
29708
|
+
/**
|
|
29709
|
+
* The type of the parameter. This cannot be changed after being set. Please see the types document for more information.
|
|
29710
|
+
* @type {string}
|
|
29711
|
+
* @memberof ParameterStorageParameterV2025
|
|
29712
|
+
*/
|
|
29713
|
+
'type'?: string;
|
|
29714
|
+
/**
|
|
29715
|
+
* The human-readable name of the parameter.
|
|
29716
|
+
* @type {string}
|
|
29717
|
+
* @memberof ParameterStorageParameterV2025
|
|
29718
|
+
*/
|
|
29719
|
+
'name': string;
|
|
29720
|
+
/**
|
|
29721
|
+
* The name of the primary field in the public fields.
|
|
29722
|
+
* @type {string}
|
|
29723
|
+
* @memberof ParameterStorageParameterV2025
|
|
29724
|
+
*/
|
|
29725
|
+
'primaryField'?: string;
|
|
29726
|
+
/**
|
|
29727
|
+
* The public fields stored for this parameter. See the types document for information about what can be stored.
|
|
29728
|
+
* @type {object}
|
|
29729
|
+
* @memberof ParameterStorageParameterV2025
|
|
29730
|
+
*/
|
|
29731
|
+
'publicFields': object;
|
|
29732
|
+
/**
|
|
29733
|
+
* Describe the parameter
|
|
29734
|
+
* @type {string}
|
|
29735
|
+
* @memberof ParameterStorageParameterV2025
|
|
29736
|
+
*/
|
|
29737
|
+
'description'?: string;
|
|
29738
|
+
/**
|
|
29739
|
+
* ISO8606 format datetime of the last time any field of the parameter was changed.
|
|
29740
|
+
* @type {string}
|
|
29741
|
+
* @memberof ParameterStorageParameterV2025
|
|
29742
|
+
*/
|
|
29743
|
+
'lastModifiedAt'?: string;
|
|
29744
|
+
/**
|
|
29745
|
+
* The ID of the user who last modified the parameter. Empty when identity is not known.
|
|
29746
|
+
* @type {string}
|
|
29747
|
+
* @memberof ParameterStorageParameterV2025
|
|
29748
|
+
*/
|
|
29749
|
+
'lastModifiedBy'?: string;
|
|
29750
|
+
/**
|
|
29751
|
+
* ISO8606 format datetime of the time the secret fields were changed on the parameter.
|
|
29752
|
+
* @type {string}
|
|
29753
|
+
* @memberof ParameterStorageParameterV2025
|
|
29754
|
+
*/
|
|
29755
|
+
'privateFieldsLastModifiedAt'?: string;
|
|
29756
|
+
/**
|
|
29757
|
+
* The ID of the user who last modified the private fields. Empty when identity is not known.
|
|
29758
|
+
* @type {string}
|
|
29759
|
+
* @memberof ParameterStorageParameterV2025
|
|
29760
|
+
*/
|
|
29761
|
+
'privateFieldsLastModifiedBy'?: string;
|
|
29762
|
+
}
|
|
29763
|
+
/**
|
|
29764
|
+
* Reference information returned in response to a request.
|
|
29765
|
+
* @export
|
|
29766
|
+
* @interface ParameterStorageReferenceV2025
|
|
29767
|
+
*/
|
|
29768
|
+
export interface ParameterStorageReferenceV2025 {
|
|
29769
|
+
/**
|
|
29770
|
+
* The ID of the reference
|
|
29771
|
+
* @type {string}
|
|
29772
|
+
* @memberof ParameterStorageReferenceV2025
|
|
29773
|
+
*/
|
|
29774
|
+
'id': string;
|
|
29775
|
+
/**
|
|
29776
|
+
* The ID of the consumer holding the reference
|
|
29777
|
+
* @type {string}
|
|
29778
|
+
* @memberof ParameterStorageReferenceV2025
|
|
29779
|
+
*/
|
|
29780
|
+
'consumerId': string;
|
|
29781
|
+
/**
|
|
29782
|
+
* The ID of the parameter that the reference is pointing to.
|
|
29783
|
+
* @type {string}
|
|
29784
|
+
* @memberof ParameterStorageReferenceV2025
|
|
29785
|
+
*/
|
|
29786
|
+
'parameterId': string;
|
|
29787
|
+
/**
|
|
29788
|
+
* The human-readable name of the reference
|
|
29789
|
+
* @type {string}
|
|
29790
|
+
* @memberof ParameterStorageReferenceV2025
|
|
29791
|
+
*/
|
|
29792
|
+
'name': string;
|
|
29793
|
+
/**
|
|
29794
|
+
* The hint string used to validate the reference
|
|
29795
|
+
* @type {string}
|
|
29796
|
+
* @memberof ParameterStorageReferenceV2025
|
|
29797
|
+
*/
|
|
29798
|
+
'usageHint'?: string;
|
|
29799
|
+
}
|
|
29800
|
+
/**
|
|
29801
|
+
* An existing parameter that needs to be updated. The type cannot be changed once the parameter is created.
|
|
29802
|
+
* @export
|
|
29803
|
+
* @interface ParameterStorageUpdateParameterV2025
|
|
29804
|
+
*/
|
|
29805
|
+
export interface ParameterStorageUpdateParameterV2025 {
|
|
29806
|
+
/**
|
|
29807
|
+
* The UUID of the parameter owner.
|
|
29808
|
+
* @type {string}
|
|
29809
|
+
* @memberof ParameterStorageUpdateParameterV2025
|
|
29810
|
+
*/
|
|
29811
|
+
'ownerId'?: string;
|
|
29812
|
+
/**
|
|
29813
|
+
* The human-readable name for the parameter.
|
|
29814
|
+
* @type {string}
|
|
29815
|
+
* @memberof ParameterStorageUpdateParameterV2025
|
|
29816
|
+
*/
|
|
29817
|
+
'name'?: string;
|
|
29818
|
+
/**
|
|
29819
|
+
* The public fields that can be stored with this parameter.
|
|
29820
|
+
* @type {object}
|
|
29821
|
+
* @memberof ParameterStorageUpdateParameterV2025
|
|
29822
|
+
*/
|
|
29823
|
+
'publicFields'?: object;
|
|
29824
|
+
/**
|
|
29825
|
+
* The private fields that can be stored with this parameter.
|
|
29826
|
+
* @type {string}
|
|
29827
|
+
* @memberof ParameterStorageUpdateParameterV2025
|
|
29828
|
+
*/
|
|
29829
|
+
'privateFields'?: string;
|
|
29830
|
+
/**
|
|
29831
|
+
* Describe the parameter
|
|
29832
|
+
* @type {string}
|
|
29833
|
+
* @memberof ParameterStorageUpdateParameterV2025
|
|
29834
|
+
*/
|
|
29835
|
+
'description'?: string;
|
|
29836
|
+
}
|
|
29389
29837
|
/**
|
|
29390
29838
|
*
|
|
29391
29839
|
* @export
|
|
@@ -30206,6 +30654,12 @@ export interface PendingApprovalV2025 {
|
|
|
30206
30654
|
* @memberof PendingApprovalV2025
|
|
30207
30655
|
*/
|
|
30208
30656
|
'requestedAccounts'?: Array<RequestedAccountRefV2025> | null;
|
|
30657
|
+
/**
|
|
30658
|
+
* The privilege level of the requested access item, if applicable.
|
|
30659
|
+
* @type {string}
|
|
30660
|
+
* @memberof PendingApprovalV2025
|
|
30661
|
+
*/
|
|
30662
|
+
'privilegeLevel'?: string | null;
|
|
30209
30663
|
}
|
|
30210
30664
|
/**
|
|
30211
30665
|
* Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.
|
|
@@ -32196,6 +32650,12 @@ export interface RequestabilityForRoleV2025 {
|
|
|
32196
32650
|
* @memberof RequestabilityForRoleV2025
|
|
32197
32651
|
*/
|
|
32198
32652
|
'approvalSchemes'?: Array<ApprovalSchemeForRoleV2025>;
|
|
32653
|
+
/**
|
|
32654
|
+
*
|
|
32655
|
+
* @type {DimensionSchemaV2025}
|
|
32656
|
+
* @memberof RequestabilityForRoleV2025
|
|
32657
|
+
*/
|
|
32658
|
+
'dimensionSchema'?: DimensionSchemaV2025;
|
|
32199
32659
|
}
|
|
32200
32660
|
/**
|
|
32201
32661
|
*
|
|
@@ -32874,6 +33334,12 @@ export interface RequestedItemStatusV2025 {
|
|
|
32874
33334
|
* @memberof RequestedItemStatusV2025
|
|
32875
33335
|
*/
|
|
32876
33336
|
'requestedAccounts'?: Array<RequestedAccountRefV2025> | null;
|
|
33337
|
+
/**
|
|
33338
|
+
* The privilege level of the requested access item, if applicable.
|
|
33339
|
+
* @type {string}
|
|
33340
|
+
* @memberof RequestedItemStatusV2025
|
|
33341
|
+
*/
|
|
33342
|
+
'privilegeLevel'?: string | null;
|
|
32877
33343
|
}
|
|
32878
33344
|
export declare const RequestedItemStatusV2025TypeV2025: {
|
|
32879
33345
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
@@ -33785,6 +34251,12 @@ export interface RoleAssignmentDtoV2025 {
|
|
|
33785
34251
|
* @memberof RoleAssignmentDtoV2025
|
|
33786
34252
|
*/
|
|
33787
34253
|
'removeDate'?: string | null;
|
|
34254
|
+
/**
|
|
34255
|
+
* Date that the assignment was added
|
|
34256
|
+
* @type {string}
|
|
34257
|
+
* @memberof RoleAssignmentDtoV2025
|
|
34258
|
+
*/
|
|
34259
|
+
'addedDate'?: string;
|
|
33788
34260
|
}
|
|
33789
34261
|
/**
|
|
33790
34262
|
*
|
|
@@ -33804,6 +34276,12 @@ export interface RoleAssignmentRefV2025 {
|
|
|
33804
34276
|
* @memberof RoleAssignmentRefV2025
|
|
33805
34277
|
*/
|
|
33806
34278
|
'role'?: BaseReferenceDtoV2025;
|
|
34279
|
+
/**
|
|
34280
|
+
* Date that the assignment was added
|
|
34281
|
+
* @type {string}
|
|
34282
|
+
* @memberof RoleAssignmentRefV2025
|
|
34283
|
+
*/
|
|
34284
|
+
'addedDate'?: string;
|
|
33807
34285
|
}
|
|
33808
34286
|
/**
|
|
33809
34287
|
* Type which indicates how a particular Identity obtained a particular Role
|
|
@@ -37560,6 +38038,7 @@ export declare const SchemaV2025FeaturesV2025: {
|
|
|
37560
38038
|
readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT";
|
|
37561
38039
|
readonly UsesUuid: "USES_UUID";
|
|
37562
38040
|
readonly ApplicationDiscovery: "APPLICATION_DISCOVERY";
|
|
38041
|
+
readonly Delete: "DELETE";
|
|
37563
38042
|
};
|
|
37564
38043
|
export type SchemaV2025FeaturesV2025 = typeof SchemaV2025FeaturesV2025[keyof typeof SchemaV2025FeaturesV2025];
|
|
37565
38044
|
/**
|
|
@@ -41690,6 +42169,7 @@ export declare const SourceV2025FeaturesV2025: {
|
|
|
41690
42169
|
readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT";
|
|
41691
42170
|
readonly UsesUuid: "USES_UUID";
|
|
41692
42171
|
readonly ApplicationDiscovery: "APPLICATION_DISCOVERY";
|
|
42172
|
+
readonly Delete: "DELETE";
|
|
41693
42173
|
};
|
|
41694
42174
|
export type SourceV2025FeaturesV2025 = typeof SourceV2025FeaturesV2025[keyof typeof SourceV2025FeaturesV2025];
|
|
41695
42175
|
export declare const SourceV2025StatusV2025: {
|
|
@@ -42722,6 +43202,25 @@ export interface SubstringV2025 {
|
|
|
42722
43202
|
[key: string]: any;
|
|
42723
43203
|
};
|
|
42724
43204
|
}
|
|
43205
|
+
/**
|
|
43206
|
+
*
|
|
43207
|
+
* @export
|
|
43208
|
+
* @interface SummaryResponseV2025
|
|
43209
|
+
*/
|
|
43210
|
+
export interface SummaryResponseV2025 {
|
|
43211
|
+
/**
|
|
43212
|
+
* The endpoint of a SailPoint API
|
|
43213
|
+
* @type {string}
|
|
43214
|
+
* @memberof SummaryResponseV2025
|
|
43215
|
+
*/
|
|
43216
|
+
'RequestedUri'?: string;
|
|
43217
|
+
/**
|
|
43218
|
+
* Number of calls made to a specific SailPoint API
|
|
43219
|
+
* @type {number}
|
|
43220
|
+
* @memberof SummaryResponseV2025
|
|
43221
|
+
*/
|
|
43222
|
+
'NumberOfCalls'?: number;
|
|
43223
|
+
}
|
|
42725
43224
|
/**
|
|
42726
43225
|
* Tagged object\'s category.
|
|
42727
43226
|
* @export
|
|
@@ -44932,10 +45431,10 @@ export interface UserLevelRequestV2025 {
|
|
|
44932
45431
|
'description': string;
|
|
44933
45432
|
/**
|
|
44934
45433
|
*
|
|
44935
|
-
* @type {
|
|
45434
|
+
* @type {PublicIdentityV2025}
|
|
44936
45435
|
* @memberof UserLevelRequestV2025
|
|
44937
45436
|
*/
|
|
44938
|
-
'owner':
|
|
45437
|
+
'owner': PublicIdentityV2025;
|
|
44939
45438
|
/**
|
|
44940
45439
|
* A list of rights associated with the user level.
|
|
44941
45440
|
* @type {Array<string>}
|
|
@@ -45011,10 +45510,10 @@ export interface UserLevelSummaryDTOV2025 {
|
|
|
45011
45510
|
'translatedRemove'?: string | null;
|
|
45012
45511
|
/**
|
|
45013
45512
|
*
|
|
45014
|
-
* @type {
|
|
45513
|
+
* @type {PublicIdentityV2025}
|
|
45015
45514
|
* @memberof UserLevelSummaryDTOV2025
|
|
45016
45515
|
*/
|
|
45017
|
-
'owner'?:
|
|
45516
|
+
'owner'?: PublicIdentityV2025;
|
|
45018
45517
|
/**
|
|
45019
45518
|
* The status of the UserLevel.
|
|
45020
45519
|
* @type {string}
|
|
@@ -45344,143 +45843,6 @@ export interface ValueV2025 {
|
|
|
45344
45843
|
*/
|
|
45345
45844
|
'value'?: string;
|
|
45346
45845
|
}
|
|
45347
|
-
/**
|
|
45348
|
-
* An object representing the nullable timestamp of when the mapping was deleted.
|
|
45349
|
-
* @export
|
|
45350
|
-
* @interface VendorConnectorMappingDeletedAtV2025
|
|
45351
|
-
*/
|
|
45352
|
-
export interface VendorConnectorMappingDeletedAtV2025 {
|
|
45353
|
-
/**
|
|
45354
|
-
* The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable.
|
|
45355
|
-
* @type {string}
|
|
45356
|
-
* @memberof VendorConnectorMappingDeletedAtV2025
|
|
45357
|
-
*/
|
|
45358
|
-
'Time'?: string;
|
|
45359
|
-
/**
|
|
45360
|
-
* A flag indicating if the \'Time\' field is set and valid, i.e., if the mapping has been deleted.
|
|
45361
|
-
* @type {boolean}
|
|
45362
|
-
* @memberof VendorConnectorMappingDeletedAtV2025
|
|
45363
|
-
*/
|
|
45364
|
-
'Valid'?: boolean;
|
|
45365
|
-
}
|
|
45366
|
-
/**
|
|
45367
|
-
* An object representing the nullable identifier of the user who deleted the mapping.
|
|
45368
|
-
* @export
|
|
45369
|
-
* @interface VendorConnectorMappingDeletedByV2025
|
|
45370
|
-
*/
|
|
45371
|
-
export interface VendorConnectorMappingDeletedByV2025 {
|
|
45372
|
-
/**
|
|
45373
|
-
* The identifier of the user who deleted the mapping, if applicable.
|
|
45374
|
-
* @type {string}
|
|
45375
|
-
* @memberof VendorConnectorMappingDeletedByV2025
|
|
45376
|
-
*/
|
|
45377
|
-
'String'?: string;
|
|
45378
|
-
/**
|
|
45379
|
-
* A flag indicating if the \'String\' field is set and valid, i.e., if the mapping has been deleted.
|
|
45380
|
-
* @type {boolean}
|
|
45381
|
-
* @memberof VendorConnectorMappingDeletedByV2025
|
|
45382
|
-
*/
|
|
45383
|
-
'Valid'?: boolean;
|
|
45384
|
-
}
|
|
45385
|
-
/**
|
|
45386
|
-
* An object representing the nullable timestamp of the last update.
|
|
45387
|
-
* @export
|
|
45388
|
-
* @interface VendorConnectorMappingUpdatedAtV2025
|
|
45389
|
-
*/
|
|
45390
|
-
export interface VendorConnectorMappingUpdatedAtV2025 {
|
|
45391
|
-
/**
|
|
45392
|
-
* The timestamp when the mapping was last updated, represented in ISO 8601 format.
|
|
45393
|
-
* @type {string}
|
|
45394
|
-
* @memberof VendorConnectorMappingUpdatedAtV2025
|
|
45395
|
-
*/
|
|
45396
|
-
'Time'?: string;
|
|
45397
|
-
/**
|
|
45398
|
-
* A flag indicating if the \'Time\' field is set and valid.
|
|
45399
|
-
* @type {boolean}
|
|
45400
|
-
* @memberof VendorConnectorMappingUpdatedAtV2025
|
|
45401
|
-
*/
|
|
45402
|
-
'Valid'?: boolean;
|
|
45403
|
-
}
|
|
45404
|
-
/**
|
|
45405
|
-
* An object representing the nullable identifier of the user who last updated the mapping.
|
|
45406
|
-
* @export
|
|
45407
|
-
* @interface VendorConnectorMappingUpdatedByV2025
|
|
45408
|
-
*/
|
|
45409
|
-
export interface VendorConnectorMappingUpdatedByV2025 {
|
|
45410
|
-
/**
|
|
45411
|
-
* The identifier of the user who last updated the mapping, if available.
|
|
45412
|
-
* @type {string}
|
|
45413
|
-
* @memberof VendorConnectorMappingUpdatedByV2025
|
|
45414
|
-
*/
|
|
45415
|
-
'String'?: string;
|
|
45416
|
-
/**
|
|
45417
|
-
* A flag indicating if the \'String\' field is set and valid.
|
|
45418
|
-
* @type {boolean}
|
|
45419
|
-
* @memberof VendorConnectorMappingUpdatedByV2025
|
|
45420
|
-
*/
|
|
45421
|
-
'Valid'?: boolean;
|
|
45422
|
-
}
|
|
45423
|
-
/**
|
|
45424
|
-
*
|
|
45425
|
-
* @export
|
|
45426
|
-
* @interface VendorConnectorMappingV2025
|
|
45427
|
-
*/
|
|
45428
|
-
export interface VendorConnectorMappingV2025 {
|
|
45429
|
-
/**
|
|
45430
|
-
* The unique identifier for the vendor-connector mapping.
|
|
45431
|
-
* @type {string}
|
|
45432
|
-
* @memberof VendorConnectorMappingV2025
|
|
45433
|
-
*/
|
|
45434
|
-
'id'?: string;
|
|
45435
|
-
/**
|
|
45436
|
-
* The name of the vendor.
|
|
45437
|
-
* @type {string}
|
|
45438
|
-
* @memberof VendorConnectorMappingV2025
|
|
45439
|
-
*/
|
|
45440
|
-
'vendor'?: string;
|
|
45441
|
-
/**
|
|
45442
|
-
* The name of the connector.
|
|
45443
|
-
* @type {string}
|
|
45444
|
-
* @memberof VendorConnectorMappingV2025
|
|
45445
|
-
*/
|
|
45446
|
-
'connector'?: string;
|
|
45447
|
-
/**
|
|
45448
|
-
* The creation timestamp of the mapping.
|
|
45449
|
-
* @type {string}
|
|
45450
|
-
* @memberof VendorConnectorMappingV2025
|
|
45451
|
-
*/
|
|
45452
|
-
'createdAt'?: string;
|
|
45453
|
-
/**
|
|
45454
|
-
* The identifier of the user who created the mapping.
|
|
45455
|
-
* @type {string}
|
|
45456
|
-
* @memberof VendorConnectorMappingV2025
|
|
45457
|
-
*/
|
|
45458
|
-
'createdBy'?: string;
|
|
45459
|
-
/**
|
|
45460
|
-
*
|
|
45461
|
-
* @type {VendorConnectorMappingUpdatedAtV2025}
|
|
45462
|
-
* @memberof VendorConnectorMappingV2025
|
|
45463
|
-
*/
|
|
45464
|
-
'updatedAt'?: VendorConnectorMappingUpdatedAtV2025 | null;
|
|
45465
|
-
/**
|
|
45466
|
-
*
|
|
45467
|
-
* @type {VendorConnectorMappingUpdatedByV2025}
|
|
45468
|
-
* @memberof VendorConnectorMappingV2025
|
|
45469
|
-
*/
|
|
45470
|
-
'updatedBy'?: VendorConnectorMappingUpdatedByV2025 | null;
|
|
45471
|
-
/**
|
|
45472
|
-
*
|
|
45473
|
-
* @type {VendorConnectorMappingDeletedAtV2025}
|
|
45474
|
-
* @memberof VendorConnectorMappingV2025
|
|
45475
|
-
*/
|
|
45476
|
-
'deletedAt'?: VendorConnectorMappingDeletedAtV2025 | null;
|
|
45477
|
-
/**
|
|
45478
|
-
*
|
|
45479
|
-
* @type {VendorConnectorMappingDeletedByV2025}
|
|
45480
|
-
* @memberof VendorConnectorMappingV2025
|
|
45481
|
-
*/
|
|
45482
|
-
'deletedBy'?: VendorConnectorMappingDeletedByV2025 | null;
|
|
45483
|
-
}
|
|
45484
45846
|
/**
|
|
45485
45847
|
* The types of objects supported for SOD violations
|
|
45486
45848
|
* @export
|
|
@@ -48451,7 +48813,7 @@ export declare const AccessRequestsV2025ApiAxiosParamCreator: (configuration?: C
|
|
|
48451
48813
|
*/
|
|
48452
48814
|
cancelAccessRequestInBulk: (bulkCancelAccessRequestV2025: BulkCancelAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48453
48815
|
/**
|
|
48454
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/
|
|
48816
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
48455
48817
|
* @summary Close access request
|
|
48456
48818
|
* @param {CloseAccessRequestV2025} closeAccessRequestV2025
|
|
48457
48819
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -48478,11 +48840,10 @@ export declare const AccessRequestsV2025ApiAxiosParamCreator: (configuration?: C
|
|
|
48478
48840
|
* @summary Identity entitlement details
|
|
48479
48841
|
* @param {string} identityId The identity ID.
|
|
48480
48842
|
* @param {string} entitlementId The entitlement ID
|
|
48481
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48482
48843
|
* @param {*} [axiosOptions] Override http request option.
|
|
48483
48844
|
* @throws {RequiredError}
|
|
48484
48845
|
*/
|
|
48485
|
-
getEntitlementDetailsForIdentity: (identityId: string, entitlementId: string,
|
|
48846
|
+
getEntitlementDetailsForIdentity: (identityId: string, entitlementId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48486
48847
|
/**
|
|
48487
48848
|
* Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users.
|
|
48488
48849
|
* @summary Access request status
|
|
@@ -48566,7 +48927,7 @@ export declare const AccessRequestsV2025ApiFp: (configuration?: Configuration) =
|
|
|
48566
48927
|
*/
|
|
48567
48928
|
cancelAccessRequestInBulk(bulkCancelAccessRequestV2025: BulkCancelAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
48568
48929
|
/**
|
|
48569
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/
|
|
48930
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
48570
48931
|
* @summary Close access request
|
|
48571
48932
|
* @param {CloseAccessRequestV2025} closeAccessRequestV2025
|
|
48572
48933
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -48593,11 +48954,10 @@ export declare const AccessRequestsV2025ApiFp: (configuration?: Configuration) =
|
|
|
48593
48954
|
* @summary Identity entitlement details
|
|
48594
48955
|
* @param {string} identityId The identity ID.
|
|
48595
48956
|
* @param {string} entitlementId The entitlement ID
|
|
48596
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
48597
48957
|
* @param {*} [axiosOptions] Override http request option.
|
|
48598
48958
|
* @throws {RequiredError}
|
|
48599
48959
|
*/
|
|
48600
|
-
getEntitlementDetailsForIdentity(identityId: string, entitlementId: string,
|
|
48960
|
+
getEntitlementDetailsForIdentity(identityId: string, entitlementId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityEntitlementDetailsV2025>>;
|
|
48601
48961
|
/**
|
|
48602
48962
|
* Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users.
|
|
48603
48963
|
* @summary Access request status
|
|
@@ -48681,7 +49041,7 @@ export declare const AccessRequestsV2025ApiFactory: (configuration?: Configurati
|
|
|
48681
49041
|
*/
|
|
48682
49042
|
cancelAccessRequestInBulk(requestParameters: AccessRequestsV2025ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
48683
49043
|
/**
|
|
48684
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/
|
|
49044
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
48685
49045
|
* @summary Close access request
|
|
48686
49046
|
* @param {AccessRequestsV2025ApiCloseAccessRequestRequest} requestParameters Request parameters.
|
|
48687
49047
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -48827,12 +49187,6 @@ export interface AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest {
|
|
|
48827
49187
|
* @memberof AccessRequestsV2025ApiGetEntitlementDetailsForIdentity
|
|
48828
49188
|
*/
|
|
48829
49189
|
readonly entitlementId: string;
|
|
48830
|
-
/**
|
|
48831
|
-
* Use this header to enable this experimental API.
|
|
48832
|
-
* @type {string}
|
|
48833
|
-
* @memberof AccessRequestsV2025ApiGetEntitlementDetailsForIdentity
|
|
48834
|
-
*/
|
|
48835
|
-
readonly xSailPointExperimental?: string;
|
|
48836
49190
|
}
|
|
48837
49191
|
/**
|
|
48838
49192
|
* Request parameters for listAccessRequestStatus operation in AccessRequestsV2025Api.
|
|
@@ -49041,7 +49395,7 @@ export declare class AccessRequestsV2025Api extends BaseAPI {
|
|
|
49041
49395
|
*/
|
|
49042
49396
|
cancelAccessRequestInBulk(requestParameters: AccessRequestsV2025ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
49043
49397
|
/**
|
|
49044
|
-
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/
|
|
49398
|
+
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
49045
49399
|
* @summary Close access request
|
|
49046
49400
|
* @param {AccessRequestsV2025ApiCloseAccessRequestRequest} requestParameters Request parameters.
|
|
49047
49401
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -50336,6 +50690,156 @@ export declare const ListAccountsDetailLevelV2025: {
|
|
|
50336
50690
|
readonly Full: "FULL";
|
|
50337
50691
|
};
|
|
50338
50692
|
export type ListAccountsDetailLevelV2025 = typeof ListAccountsDetailLevelV2025[keyof typeof ListAccountsDetailLevelV2025];
|
|
50693
|
+
/**
|
|
50694
|
+
* ApiUsageV2025Api - axios parameter creator
|
|
50695
|
+
* @export
|
|
50696
|
+
*/
|
|
50697
|
+
export declare const ApiUsageV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
50698
|
+
/**
|
|
50699
|
+
* This API gets an aggregated number of all API calls from an org in a given timespan.
|
|
50700
|
+
* @summary Total number of API requests
|
|
50701
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
50702
|
+
* @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50703
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50704
|
+
* @throws {RequiredError}
|
|
50705
|
+
*/
|
|
50706
|
+
getTotalCount: (xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50707
|
+
/**
|
|
50708
|
+
* This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls.
|
|
50709
|
+
* @summary Get Api Summary
|
|
50710
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
50711
|
+
* @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50712
|
+
* @param {number} [limit] Max number of results to return.
|
|
50713
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
50714
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50715
|
+
* @throws {RequiredError}
|
|
50716
|
+
*/
|
|
50717
|
+
listApiSummary: (xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50718
|
+
};
|
|
50719
|
+
/**
|
|
50720
|
+
* ApiUsageV2025Api - functional programming interface
|
|
50721
|
+
* @export
|
|
50722
|
+
*/
|
|
50723
|
+
export declare const ApiUsageV2025ApiFp: (configuration?: Configuration) => {
|
|
50724
|
+
/**
|
|
50725
|
+
* This API gets an aggregated number of all API calls from an org in a given timespan.
|
|
50726
|
+
* @summary Total number of API requests
|
|
50727
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
50728
|
+
* @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50729
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50730
|
+
* @throws {RequiredError}
|
|
50731
|
+
*/
|
|
50732
|
+
getTotalCount(xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
50733
|
+
/**
|
|
50734
|
+
* This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls.
|
|
50735
|
+
* @summary Get Api Summary
|
|
50736
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
50737
|
+
* @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50738
|
+
* @param {number} [limit] Max number of results to return.
|
|
50739
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
50740
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50741
|
+
* @throws {RequiredError}
|
|
50742
|
+
*/
|
|
50743
|
+
listApiSummary(xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SummaryResponseV2025>>>;
|
|
50744
|
+
};
|
|
50745
|
+
/**
|
|
50746
|
+
* ApiUsageV2025Api - factory interface
|
|
50747
|
+
* @export
|
|
50748
|
+
*/
|
|
50749
|
+
export declare const ApiUsageV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
50750
|
+
/**
|
|
50751
|
+
* This API gets an aggregated number of all API calls from an org in a given timespan.
|
|
50752
|
+
* @summary Total number of API requests
|
|
50753
|
+
* @param {ApiUsageV2025ApiGetTotalCountRequest} requestParameters Request parameters.
|
|
50754
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50755
|
+
* @throws {RequiredError}
|
|
50756
|
+
*/
|
|
50757
|
+
getTotalCount(requestParameters?: ApiUsageV2025ApiGetTotalCountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
50758
|
+
/**
|
|
50759
|
+
* This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls.
|
|
50760
|
+
* @summary Get Api Summary
|
|
50761
|
+
* @param {ApiUsageV2025ApiListApiSummaryRequest} requestParameters Request parameters.
|
|
50762
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50763
|
+
* @throws {RequiredError}
|
|
50764
|
+
*/
|
|
50765
|
+
listApiSummary(requestParameters?: ApiUsageV2025ApiListApiSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SummaryResponseV2025>>;
|
|
50766
|
+
};
|
|
50767
|
+
/**
|
|
50768
|
+
* Request parameters for getTotalCount operation in ApiUsageV2025Api.
|
|
50769
|
+
* @export
|
|
50770
|
+
* @interface ApiUsageV2025ApiGetTotalCountRequest
|
|
50771
|
+
*/
|
|
50772
|
+
export interface ApiUsageV2025ApiGetTotalCountRequest {
|
|
50773
|
+
/**
|
|
50774
|
+
* Use this header to enable this experimental API.
|
|
50775
|
+
* @type {string}
|
|
50776
|
+
* @memberof ApiUsageV2025ApiGetTotalCount
|
|
50777
|
+
*/
|
|
50778
|
+
readonly xSailPointExperimental?: string;
|
|
50779
|
+
/**
|
|
50780
|
+
* 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50781
|
+
* @type {string}
|
|
50782
|
+
* @memberof ApiUsageV2025ApiGetTotalCount
|
|
50783
|
+
*/
|
|
50784
|
+
readonly filters?: string;
|
|
50785
|
+
}
|
|
50786
|
+
/**
|
|
50787
|
+
* Request parameters for listApiSummary operation in ApiUsageV2025Api.
|
|
50788
|
+
* @export
|
|
50789
|
+
* @interface ApiUsageV2025ApiListApiSummaryRequest
|
|
50790
|
+
*/
|
|
50791
|
+
export interface ApiUsageV2025ApiListApiSummaryRequest {
|
|
50792
|
+
/**
|
|
50793
|
+
* Use this header to enable this experimental API.
|
|
50794
|
+
* @type {string}
|
|
50795
|
+
* @memberof ApiUsageV2025ApiListApiSummary
|
|
50796
|
+
*/
|
|
50797
|
+
readonly xSailPointExperimental?: string;
|
|
50798
|
+
/**
|
|
50799
|
+
* 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq*
|
|
50800
|
+
* @type {string}
|
|
50801
|
+
* @memberof ApiUsageV2025ApiListApiSummary
|
|
50802
|
+
*/
|
|
50803
|
+
readonly filters?: string;
|
|
50804
|
+
/**
|
|
50805
|
+
* Max number of results to return.
|
|
50806
|
+
* @type {number}
|
|
50807
|
+
* @memberof ApiUsageV2025ApiListApiSummary
|
|
50808
|
+
*/
|
|
50809
|
+
readonly limit?: number;
|
|
50810
|
+
/**
|
|
50811
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
50812
|
+
* @type {number}
|
|
50813
|
+
* @memberof ApiUsageV2025ApiListApiSummary
|
|
50814
|
+
*/
|
|
50815
|
+
readonly offset?: number;
|
|
50816
|
+
}
|
|
50817
|
+
/**
|
|
50818
|
+
* ApiUsageV2025Api - object-oriented interface
|
|
50819
|
+
* @export
|
|
50820
|
+
* @class ApiUsageV2025Api
|
|
50821
|
+
* @extends {BaseAPI}
|
|
50822
|
+
*/
|
|
50823
|
+
export declare class ApiUsageV2025Api extends BaseAPI {
|
|
50824
|
+
/**
|
|
50825
|
+
* This API gets an aggregated number of all API calls from an org in a given timespan.
|
|
50826
|
+
* @summary Total number of API requests
|
|
50827
|
+
* @param {ApiUsageV2025ApiGetTotalCountRequest} requestParameters Request parameters.
|
|
50828
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50829
|
+
* @throws {RequiredError}
|
|
50830
|
+
* @memberof ApiUsageV2025Api
|
|
50831
|
+
*/
|
|
50832
|
+
getTotalCount(requestParameters?: ApiUsageV2025ApiGetTotalCountRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
50833
|
+
/**
|
|
50834
|
+
* This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls.
|
|
50835
|
+
* @summary Get Api Summary
|
|
50836
|
+
* @param {ApiUsageV2025ApiListApiSummaryRequest} requestParameters Request parameters.
|
|
50837
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
50838
|
+
* @throws {RequiredError}
|
|
50839
|
+
* @memberof ApiUsageV2025Api
|
|
50840
|
+
*/
|
|
50841
|
+
listApiSummary(requestParameters?: ApiUsageV2025ApiListApiSummaryRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SummaryResponseV2025[], any>>;
|
|
50842
|
+
}
|
|
50339
50843
|
/**
|
|
50340
50844
|
* ApplicationDiscoveryV2025Api - axios parameter creator
|
|
50341
50845
|
* @export
|
|
@@ -50537,6 +51041,22 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
50537
51041
|
* @throws {RequiredError}
|
|
50538
51042
|
*/
|
|
50539
51043
|
approveApproval: (id: string, approvalApproveRequestV2025?: ApprovalApproveRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51044
|
+
/**
|
|
51045
|
+
* Bulk Approves specified approval requests on behalf of the caller
|
|
51046
|
+
* @summary Post Bulk Approve Approvals
|
|
51047
|
+
* @param {BulkApproveRequestDTOV2025} bulkApproveRequestDTOV2025
|
|
51048
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51049
|
+
* @throws {RequiredError}
|
|
51050
|
+
*/
|
|
51051
|
+
approveApproval_1: (bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51052
|
+
/**
|
|
51053
|
+
* Bulk cancels specified approval requests on behalf of the caller
|
|
51054
|
+
* @summary Post Bulk Cancel Approvals
|
|
51055
|
+
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
51056
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51057
|
+
* @throws {RequiredError}
|
|
51058
|
+
*/
|
|
51059
|
+
cancelApproval: (bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50540
51060
|
/**
|
|
50541
51061
|
* 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.
|
|
50542
51062
|
* @summary Get an approval
|
|
@@ -50547,9 +51067,9 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
50547
51067
|
*/
|
|
50548
51068
|
getApproval: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50549
51069
|
/**
|
|
50550
|
-
* 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. Absence of all query parameters for admins will return all approvals in the org.
|
|
51070
|
+
* 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.
|
|
50551
51071
|
* @summary Get approvals
|
|
50552
|
-
* @param {boolean} [mine] Returns the list of approvals for the current caller.
|
|
51072
|
+
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
50553
51073
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
50554
51074
|
* @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
50555
51075
|
* @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
@@ -50558,14 +51078,39 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
50558
51078
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
50559
51079
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
50560
51080
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
50561
|
-
* @param {
|
|
50562
|
-
* @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* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq*
|
|
51081
|
+
* @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, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **approvalId**: *eq, ne, in, co, sw* **tenantId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le*
|
|
50563
51082
|
* @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.
|
|
50564
51083
|
* @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.
|
|
50565
51084
|
* @param {*} [axiosOptions] Override http request option.
|
|
50566
51085
|
* @throws {RequiredError}
|
|
50567
51086
|
*/
|
|
50568
|
-
getApprovals: (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean,
|
|
51087
|
+
getApprovals: (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51088
|
+
/**
|
|
51089
|
+
* Retrieves a singular approval configuration that matches the given ID
|
|
51090
|
+
* @summary Get Approval Config
|
|
51091
|
+
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), (sourceID), (applicationID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
51092
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51093
|
+
* @throws {RequiredError}
|
|
51094
|
+
*/
|
|
51095
|
+
getApprovalsConfig: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51096
|
+
/**
|
|
51097
|
+
* Bulk reassigns specified approval requests on behalf of the caller
|
|
51098
|
+
* @summary Post Bulk Reassign Approvals
|
|
51099
|
+
* @param {BulkReassignRequestDTOV2025} bulkReassignRequestDTOV2025
|
|
51100
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51101
|
+
* @throws {RequiredError}
|
|
51102
|
+
*/
|
|
51103
|
+
moveApproval: (bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51104
|
+
/**
|
|
51105
|
+
* Upserts a singular approval configuration that matches the given configID and configScope. If id and scope are not provided, it will default to setting the tenant config.
|
|
51106
|
+
* @summary Put Approval Config
|
|
51107
|
+
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
51108
|
+
* @param {string} [id] The ID defined by the scope field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51109
|
+
* @param {string} [scope] The scope of the field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51110
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51111
|
+
* @throws {RequiredError}
|
|
51112
|
+
*/
|
|
51113
|
+
putApprovalsConfig: (approvalConfigV2025: ApprovalConfigV2025, id?: string, scope?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50569
51114
|
/**
|
|
50570
51115
|
* Currently this endpoint only supports Entitlement Description Approvals. Rejects a specified approval request on behalf of the caller. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
50571
51116
|
* @summary Post Approvals Reject
|
|
@@ -50575,6 +51120,14 @@ export declare const ApprovalsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
50575
51120
|
* @throws {RequiredError}
|
|
50576
51121
|
*/
|
|
50577
51122
|
rejectApproval: (id: string, approvalRejectRequestV2025?: ApprovalRejectRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51123
|
+
/**
|
|
51124
|
+
* Bulk reject specified approval requests on behalf of the caller
|
|
51125
|
+
* @summary Post Bulk Reject Approvals
|
|
51126
|
+
* @param {BulkRejectRequestDTOV2025} bulkRejectRequestDTOV2025
|
|
51127
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51128
|
+
* @throws {RequiredError}
|
|
51129
|
+
*/
|
|
51130
|
+
rejectApproval_2: (bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50578
51131
|
/**
|
|
50579
51132
|
* Currently this endpoint only supports Entitlement Description Approvals. Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
|
|
50580
51133
|
* @summary Post Approvals Attributes
|
|
@@ -50617,6 +51170,22 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
50617
51170
|
* @throws {RequiredError}
|
|
50618
51171
|
*/
|
|
50619
51172
|
approveApproval(id: string, approvalApproveRequestV2025?: ApprovalApproveRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
51173
|
+
/**
|
|
51174
|
+
* Bulk Approves specified approval requests on behalf of the caller
|
|
51175
|
+
* @summary Post Bulk Approve Approvals
|
|
51176
|
+
* @param {BulkApproveRequestDTOV2025} bulkApproveRequestDTOV2025
|
|
51177
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51178
|
+
* @throws {RequiredError}
|
|
51179
|
+
*/
|
|
51180
|
+
approveApproval_1(bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
51181
|
+
/**
|
|
51182
|
+
* Bulk cancels specified approval requests on behalf of the caller
|
|
51183
|
+
* @summary Post Bulk Cancel Approvals
|
|
51184
|
+
* @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025
|
|
51185
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51186
|
+
* @throws {RequiredError}
|
|
51187
|
+
*/
|
|
51188
|
+
cancelApproval(bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
50620
51189
|
/**
|
|
50621
51190
|
* 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.
|
|
50622
51191
|
* @summary Get an approval
|
|
@@ -50627,9 +51196,9 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
50627
51196
|
*/
|
|
50628
51197
|
getApproval(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalV2025>>;
|
|
50629
51198
|
/**
|
|
50630
|
-
* 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. Absence of all query parameters for admins will return all approvals in the org.
|
|
51199
|
+
* 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.
|
|
50631
51200
|
* @summary Get approvals
|
|
50632
|
-
* @param {boolean} [mine] Returns the list of approvals for the current caller.
|
|
51201
|
+
* @param {boolean} [mine] Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
50633
51202
|
* @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
50634
51203
|
* @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
50635
51204
|
* @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin.
|
|
@@ -50638,14 +51207,39 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
50638
51207
|
* @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments.
|
|
50639
51208
|
* @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers.
|
|
50640
51209
|
* @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch information.
|
|
50641
|
-
* @param {
|
|
50642
|
-
* @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* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq*
|
|
51210
|
+
* @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, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **approvalId**: *eq, ne, in, co, sw* **tenantId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le*
|
|
50643
51211
|
* @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.
|
|
50644
51212
|
* @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.
|
|
50645
51213
|
* @param {*} [axiosOptions] Override http request option.
|
|
50646
51214
|
* @throws {RequiredError}
|
|
50647
51215
|
*/
|
|
50648
|
-
getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean,
|
|
51216
|
+
getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApprovalV2025>>>;
|
|
51217
|
+
/**
|
|
51218
|
+
* Retrieves a singular approval configuration that matches the given ID
|
|
51219
|
+
* @summary Get Approval Config
|
|
51220
|
+
* @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), (sourceID), (applicationID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
51221
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51222
|
+
* @throws {RequiredError}
|
|
51223
|
+
*/
|
|
51224
|
+
getApprovalsConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalConfigV2025>>;
|
|
51225
|
+
/**
|
|
51226
|
+
* Bulk reassigns specified approval requests on behalf of the caller
|
|
51227
|
+
* @summary Post Bulk Reassign Approvals
|
|
51228
|
+
* @param {BulkReassignRequestDTOV2025} bulkReassignRequestDTOV2025
|
|
51229
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51230
|
+
* @throws {RequiredError}
|
|
51231
|
+
*/
|
|
51232
|
+
moveApproval(bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
51233
|
+
/**
|
|
51234
|
+
* Upserts a singular approval configuration that matches the given configID and configScope. If id and scope are not provided, it will default to setting the tenant config.
|
|
51235
|
+
* @summary Put Approval Config
|
|
51236
|
+
* @param {ApprovalConfigV2025} approvalConfigV2025
|
|
51237
|
+
* @param {string} [id] The ID defined by the scope field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51238
|
+
* @param {string} [scope] The scope of the field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51239
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51240
|
+
* @throws {RequiredError}
|
|
51241
|
+
*/
|
|
51242
|
+
putApprovalsConfig(approvalConfigV2025: ApprovalConfigV2025, id?: string, scope?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalConfigV2025>>;
|
|
50649
51243
|
/**
|
|
50650
51244
|
* Currently this endpoint only supports Entitlement Description Approvals. Rejects a specified approval request on behalf of the caller. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
50651
51245
|
* @summary Post Approvals Reject
|
|
@@ -50655,6 +51249,14 @@ export declare const ApprovalsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
50655
51249
|
* @throws {RequiredError}
|
|
50656
51250
|
*/
|
|
50657
51251
|
rejectApproval(id: string, approvalRejectRequestV2025?: ApprovalRejectRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
51252
|
+
/**
|
|
51253
|
+
* Bulk reject specified approval requests on behalf of the caller
|
|
51254
|
+
* @summary Post Bulk Reject Approvals
|
|
51255
|
+
* @param {BulkRejectRequestDTOV2025} bulkRejectRequestDTOV2025
|
|
51256
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51257
|
+
* @throws {RequiredError}
|
|
51258
|
+
*/
|
|
51259
|
+
rejectApproval_2(bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
50658
51260
|
/**
|
|
50659
51261
|
* Currently this endpoint only supports Entitlement Description Approvals. Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
|
|
50660
51262
|
* @summary Post Approvals Attributes
|
|
@@ -50696,6 +51298,22 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
50696
51298
|
* @throws {RequiredError}
|
|
50697
51299
|
*/
|
|
50698
51300
|
approveApproval(requestParameters: ApprovalsV2025ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2025>;
|
|
51301
|
+
/**
|
|
51302
|
+
* Bulk Approves specified approval requests on behalf of the caller
|
|
51303
|
+
* @summary Post Bulk Approve Approvals
|
|
51304
|
+
* @param {ApprovalsV2025ApiApproveApproval0Request} requestParameters Request parameters.
|
|
51305
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51306
|
+
* @throws {RequiredError}
|
|
51307
|
+
*/
|
|
51308
|
+
approveApproval_1(requestParameters: ApprovalsV2025ApiApproveApproval0Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
51309
|
+
/**
|
|
51310
|
+
* Bulk cancels specified approval requests on behalf of the caller
|
|
51311
|
+
* @summary Post Bulk Cancel Approvals
|
|
51312
|
+
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
51313
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51314
|
+
* @throws {RequiredError}
|
|
51315
|
+
*/
|
|
51316
|
+
cancelApproval(requestParameters: ApprovalsV2025ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
50699
51317
|
/**
|
|
50700
51318
|
* 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.
|
|
50701
51319
|
* @summary Get an approval
|
|
@@ -50705,13 +51323,37 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
50705
51323
|
*/
|
|
50706
51324
|
getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalV2025>;
|
|
50707
51325
|
/**
|
|
50708
|
-
* 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. Absence of all query parameters for admins will return all approvals in the org.
|
|
51326
|
+
* 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.
|
|
50709
51327
|
* @summary Get approvals
|
|
50710
51328
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
50711
51329
|
* @param {*} [axiosOptions] Override http request option.
|
|
50712
51330
|
* @throws {RequiredError}
|
|
50713
51331
|
*/
|
|
50714
51332
|
getApprovals(requestParameters?: ApprovalsV2025ApiGetApprovalsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ApprovalV2025>>;
|
|
51333
|
+
/**
|
|
51334
|
+
* Retrieves a singular approval configuration that matches the given ID
|
|
51335
|
+
* @summary Get Approval Config
|
|
51336
|
+
* @param {ApprovalsV2025ApiGetApprovalsConfigRequest} requestParameters Request parameters.
|
|
51337
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51338
|
+
* @throws {RequiredError}
|
|
51339
|
+
*/
|
|
51340
|
+
getApprovalsConfig(requestParameters: ApprovalsV2025ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalConfigV2025>;
|
|
51341
|
+
/**
|
|
51342
|
+
* Bulk reassigns specified approval requests on behalf of the caller
|
|
51343
|
+
* @summary Post Bulk Reassign Approvals
|
|
51344
|
+
* @param {ApprovalsV2025ApiMoveApprovalRequest} requestParameters Request parameters.
|
|
51345
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51346
|
+
* @throws {RequiredError}
|
|
51347
|
+
*/
|
|
51348
|
+
moveApproval(requestParameters: ApprovalsV2025ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
51349
|
+
/**
|
|
51350
|
+
* Upserts a singular approval configuration that matches the given configID and configScope. If id and scope are not provided, it will default to setting the tenant config.
|
|
51351
|
+
* @summary Put Approval Config
|
|
51352
|
+
* @param {ApprovalsV2025ApiPutApprovalsConfigRequest} requestParameters Request parameters.
|
|
51353
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51354
|
+
* @throws {RequiredError}
|
|
51355
|
+
*/
|
|
51356
|
+
putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ApprovalConfigV2025>;
|
|
50715
51357
|
/**
|
|
50716
51358
|
* Currently this endpoint only supports Entitlement Description Approvals. Rejects a specified approval request on behalf of the caller. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
50717
51359
|
* @summary Post Approvals Reject
|
|
@@ -50720,6 +51362,14 @@ export declare const ApprovalsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
50720
51362
|
* @throws {RequiredError}
|
|
50721
51363
|
*/
|
|
50722
51364
|
rejectApproval(requestParameters: ApprovalsV2025ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
51365
|
+
/**
|
|
51366
|
+
* Bulk reject specified approval requests on behalf of the caller
|
|
51367
|
+
* @summary Post Bulk Reject Approvals
|
|
51368
|
+
* @param {ApprovalsV2025ApiRejectApproval0Request} requestParameters Request parameters.
|
|
51369
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51370
|
+
* @throws {RequiredError}
|
|
51371
|
+
*/
|
|
51372
|
+
rejectApproval_2(requestParameters: ApprovalsV2025ApiRejectApproval0Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
50723
51373
|
/**
|
|
50724
51374
|
* Currently this endpoint only supports Entitlement Description Approvals. Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
|
|
50725
51375
|
* @summary Post Approvals Attributes
|
|
@@ -50764,6 +51414,32 @@ export interface ApprovalsV2025ApiApproveApprovalRequest {
|
|
|
50764
51414
|
*/
|
|
50765
51415
|
readonly approvalApproveRequestV2025?: ApprovalApproveRequestV2025;
|
|
50766
51416
|
}
|
|
51417
|
+
/**
|
|
51418
|
+
* Request parameters for approveApproval_1 operation in ApprovalsV2025Api.
|
|
51419
|
+
* @export
|
|
51420
|
+
* @interface ApprovalsV2025ApiApproveApproval0Request
|
|
51421
|
+
*/
|
|
51422
|
+
export interface ApprovalsV2025ApiApproveApproval0Request {
|
|
51423
|
+
/**
|
|
51424
|
+
*
|
|
51425
|
+
* @type {BulkApproveRequestDTOV2025}
|
|
51426
|
+
* @memberof ApprovalsV2025ApiApproveApproval0
|
|
51427
|
+
*/
|
|
51428
|
+
readonly bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025;
|
|
51429
|
+
}
|
|
51430
|
+
/**
|
|
51431
|
+
* Request parameters for cancelApproval operation in ApprovalsV2025Api.
|
|
51432
|
+
* @export
|
|
51433
|
+
* @interface ApprovalsV2025ApiCancelApprovalRequest
|
|
51434
|
+
*/
|
|
51435
|
+
export interface ApprovalsV2025ApiCancelApprovalRequest {
|
|
51436
|
+
/**
|
|
51437
|
+
*
|
|
51438
|
+
* @type {BulkCancelRequestDTOV2025}
|
|
51439
|
+
* @memberof ApprovalsV2025ApiCancelApproval
|
|
51440
|
+
*/
|
|
51441
|
+
readonly bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025;
|
|
51442
|
+
}
|
|
50767
51443
|
/**
|
|
50768
51444
|
* Request parameters for getApproval operation in ApprovalsV2025Api.
|
|
50769
51445
|
* @export
|
|
@@ -50790,7 +51466,7 @@ export interface ApprovalsV2025ApiGetApprovalRequest {
|
|
|
50790
51466
|
*/
|
|
50791
51467
|
export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
50792
51468
|
/**
|
|
50793
|
-
* Returns the list of approvals for the current caller.
|
|
51469
|
+
* Returns the list of approvals for the current caller. Defaults to false if admin, true otherwise.
|
|
50794
51470
|
* @type {boolean}
|
|
50795
51471
|
* @memberof ApprovalsV2025ApiGetApprovals
|
|
50796
51472
|
*/
|
|
@@ -50844,13 +51520,7 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
50844
51520
|
*/
|
|
50845
51521
|
readonly includeBatchInfo?: boolean;
|
|
50846
51522
|
/**
|
|
50847
|
-
*
|
|
50848
|
-
* @type {boolean}
|
|
50849
|
-
* @memberof ApprovalsV2025ApiGetApprovals
|
|
50850
|
-
*/
|
|
50851
|
-
readonly includeBatchInfo2?: boolean;
|
|
50852
|
-
/**
|
|
50853
|
-
* 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* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq*
|
|
51523
|
+
* 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, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **approvalId**: *eq, ne, in, co, sw* **tenantId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le*
|
|
50854
51524
|
* @type {string}
|
|
50855
51525
|
* @memberof ApprovalsV2025ApiGetApprovals
|
|
50856
51526
|
*/
|
|
@@ -50868,6 +51538,57 @@ export interface ApprovalsV2025ApiGetApprovalsRequest {
|
|
|
50868
51538
|
*/
|
|
50869
51539
|
readonly offset?: number;
|
|
50870
51540
|
}
|
|
51541
|
+
/**
|
|
51542
|
+
* Request parameters for getApprovalsConfig operation in ApprovalsV2025Api.
|
|
51543
|
+
* @export
|
|
51544
|
+
* @interface ApprovalsV2025ApiGetApprovalsConfigRequest
|
|
51545
|
+
*/
|
|
51546
|
+
export interface ApprovalsV2025ApiGetApprovalsConfigRequest {
|
|
51547
|
+
/**
|
|
51548
|
+
* The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), (sourceID), (applicationID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", (tenantID)]
|
|
51549
|
+
* @type {string}
|
|
51550
|
+
* @memberof ApprovalsV2025ApiGetApprovalsConfig
|
|
51551
|
+
*/
|
|
51552
|
+
readonly id: string;
|
|
51553
|
+
}
|
|
51554
|
+
/**
|
|
51555
|
+
* Request parameters for moveApproval operation in ApprovalsV2025Api.
|
|
51556
|
+
* @export
|
|
51557
|
+
* @interface ApprovalsV2025ApiMoveApprovalRequest
|
|
51558
|
+
*/
|
|
51559
|
+
export interface ApprovalsV2025ApiMoveApprovalRequest {
|
|
51560
|
+
/**
|
|
51561
|
+
*
|
|
51562
|
+
* @type {BulkReassignRequestDTOV2025}
|
|
51563
|
+
* @memberof ApprovalsV2025ApiMoveApproval
|
|
51564
|
+
*/
|
|
51565
|
+
readonly bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025;
|
|
51566
|
+
}
|
|
51567
|
+
/**
|
|
51568
|
+
* Request parameters for putApprovalsConfig operation in ApprovalsV2025Api.
|
|
51569
|
+
* @export
|
|
51570
|
+
* @interface ApprovalsV2025ApiPutApprovalsConfigRequest
|
|
51571
|
+
*/
|
|
51572
|
+
export interface ApprovalsV2025ApiPutApprovalsConfigRequest {
|
|
51573
|
+
/**
|
|
51574
|
+
*
|
|
51575
|
+
* @type {ApprovalConfigV2025}
|
|
51576
|
+
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
51577
|
+
*/
|
|
51578
|
+
readonly approvalConfigV2025: ApprovalConfigV2025;
|
|
51579
|
+
/**
|
|
51580
|
+
* The ID defined by the scope field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51581
|
+
* @type {string}
|
|
51582
|
+
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
51583
|
+
*/
|
|
51584
|
+
readonly id?: string;
|
|
51585
|
+
/**
|
|
51586
|
+
* The scope of the field, where [[id]]:[[scope]] is the following: [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE [[sourceID]]:SOURCE [[applicationID]]:APPLICATION ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE [[tenantID]]:TENANT
|
|
51587
|
+
* @type {string}
|
|
51588
|
+
* @memberof ApprovalsV2025ApiPutApprovalsConfig
|
|
51589
|
+
*/
|
|
51590
|
+
readonly scope?: string;
|
|
51591
|
+
}
|
|
50871
51592
|
/**
|
|
50872
51593
|
* Request parameters for rejectApproval operation in ApprovalsV2025Api.
|
|
50873
51594
|
* @export
|
|
@@ -50887,6 +51608,19 @@ export interface ApprovalsV2025ApiRejectApprovalRequest {
|
|
|
50887
51608
|
*/
|
|
50888
51609
|
readonly approvalRejectRequestV2025?: ApprovalRejectRequestV2025;
|
|
50889
51610
|
}
|
|
51611
|
+
/**
|
|
51612
|
+
* Request parameters for rejectApproval_2 operation in ApprovalsV2025Api.
|
|
51613
|
+
* @export
|
|
51614
|
+
* @interface ApprovalsV2025ApiRejectApproval0Request
|
|
51615
|
+
*/
|
|
51616
|
+
export interface ApprovalsV2025ApiRejectApproval0Request {
|
|
51617
|
+
/**
|
|
51618
|
+
*
|
|
51619
|
+
* @type {BulkRejectRequestDTOV2025}
|
|
51620
|
+
* @memberof ApprovalsV2025ApiRejectApproval0
|
|
51621
|
+
*/
|
|
51622
|
+
readonly bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025;
|
|
51623
|
+
}
|
|
50890
51624
|
/**
|
|
50891
51625
|
* Request parameters for updateApprovalsAttributes operation in ApprovalsV2025Api.
|
|
50892
51626
|
* @export
|
|
@@ -50960,6 +51694,24 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
50960
51694
|
* @memberof ApprovalsV2025Api
|
|
50961
51695
|
*/
|
|
50962
51696
|
approveApproval(requestParameters: ApprovalsV2025ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025, any>>;
|
|
51697
|
+
/**
|
|
51698
|
+
* Bulk Approves specified approval requests on behalf of the caller
|
|
51699
|
+
* @summary Post Bulk Approve Approvals
|
|
51700
|
+
* @param {ApprovalsV2025ApiApproveApproval0Request} requestParameters Request parameters.
|
|
51701
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51702
|
+
* @throws {RequiredError}
|
|
51703
|
+
* @memberof ApprovalsV2025Api
|
|
51704
|
+
*/
|
|
51705
|
+
approveApproval_1(requestParameters: ApprovalsV2025ApiApproveApproval0Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
51706
|
+
/**
|
|
51707
|
+
* Bulk cancels specified approval requests on behalf of the caller
|
|
51708
|
+
* @summary Post Bulk Cancel Approvals
|
|
51709
|
+
* @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters.
|
|
51710
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51711
|
+
* @throws {RequiredError}
|
|
51712
|
+
* @memberof ApprovalsV2025Api
|
|
51713
|
+
*/
|
|
51714
|
+
cancelApproval(requestParameters: ApprovalsV2025ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
50963
51715
|
/**
|
|
50964
51716
|
* 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.
|
|
50965
51717
|
* @summary Get an approval
|
|
@@ -50970,7 +51722,7 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
50970
51722
|
*/
|
|
50971
51723
|
getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025, any>>;
|
|
50972
51724
|
/**
|
|
50973
|
-
* 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. Absence of all query parameters for admins will return all approvals in the org.
|
|
51725
|
+
* 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.
|
|
50974
51726
|
* @summary Get approvals
|
|
50975
51727
|
* @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters.
|
|
50976
51728
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -50978,6 +51730,33 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
50978
51730
|
* @memberof ApprovalsV2025Api
|
|
50979
51731
|
*/
|
|
50980
51732
|
getApprovals(requestParameters?: ApprovalsV2025ApiGetApprovalsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalV2025[], any>>;
|
|
51733
|
+
/**
|
|
51734
|
+
* Retrieves a singular approval configuration that matches the given ID
|
|
51735
|
+
* @summary Get Approval Config
|
|
51736
|
+
* @param {ApprovalsV2025ApiGetApprovalsConfigRequest} requestParameters Request parameters.
|
|
51737
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51738
|
+
* @throws {RequiredError}
|
|
51739
|
+
* @memberof ApprovalsV2025Api
|
|
51740
|
+
*/
|
|
51741
|
+
getApprovalsConfig(requestParameters: ApprovalsV2025ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalConfigV2025, any>>;
|
|
51742
|
+
/**
|
|
51743
|
+
* Bulk reassigns specified approval requests on behalf of the caller
|
|
51744
|
+
* @summary Post Bulk Reassign Approvals
|
|
51745
|
+
* @param {ApprovalsV2025ApiMoveApprovalRequest} requestParameters Request parameters.
|
|
51746
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51747
|
+
* @throws {RequiredError}
|
|
51748
|
+
* @memberof ApprovalsV2025Api
|
|
51749
|
+
*/
|
|
51750
|
+
moveApproval(requestParameters: ApprovalsV2025ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
51751
|
+
/**
|
|
51752
|
+
* Upserts a singular approval configuration that matches the given configID and configScope. If id and scope are not provided, it will default to setting the tenant config.
|
|
51753
|
+
* @summary Put Approval Config
|
|
51754
|
+
* @param {ApprovalsV2025ApiPutApprovalsConfigRequest} requestParameters Request parameters.
|
|
51755
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51756
|
+
* @throws {RequiredError}
|
|
51757
|
+
* @memberof ApprovalsV2025Api
|
|
51758
|
+
*/
|
|
51759
|
+
putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalConfigV2025, any>>;
|
|
50981
51760
|
/**
|
|
50982
51761
|
* Currently this endpoint only supports Entitlement Description Approvals. Rejects a specified approval request on behalf of the caller. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
|
50983
51762
|
* @summary Post Approvals Reject
|
|
@@ -50987,6 +51766,15 @@ export declare class ApprovalsV2025Api extends BaseAPI {
|
|
|
50987
51766
|
* @memberof ApprovalsV2025Api
|
|
50988
51767
|
*/
|
|
50989
51768
|
rejectApproval(requestParameters: ApprovalsV2025ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
51769
|
+
/**
|
|
51770
|
+
* Bulk reject specified approval requests on behalf of the caller
|
|
51771
|
+
* @summary Post Bulk Reject Approvals
|
|
51772
|
+
* @param {ApprovalsV2025ApiRejectApproval0Request} requestParameters Request parameters.
|
|
51773
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
51774
|
+
* @throws {RequiredError}
|
|
51775
|
+
* @memberof ApprovalsV2025Api
|
|
51776
|
+
*/
|
|
51777
|
+
rejectApproval_2(requestParameters: ApprovalsV2025ApiRejectApproval0Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
50990
51778
|
/**
|
|
50991
51779
|
* Currently this endpoint only supports Entitlement Description Approvals. Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
|
|
50992
51780
|
* @summary Post Approvals Attributes
|
|
@@ -55438,7 +56226,7 @@ export declare const ConfigurationHubV2025ApiAxiosParamCreator: (configuration?:
|
|
|
55438
56226
|
*/
|
|
55439
56227
|
createScheduledAction: (scheduledActionPayloadV2025: ScheduledActionPayloadV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55440
56228
|
/**
|
|
55441
|
-
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
56229
|
+
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects.
|
|
55442
56230
|
* @summary Upload a configuration
|
|
55443
56231
|
* @param {File} data JSON file containing the objects to be imported.
|
|
55444
56232
|
* @param {string} name Name that will be assigned to the uploaded configuration file.
|
|
@@ -55608,7 +56396,7 @@ export declare const ConfigurationHubV2025ApiFp: (configuration?: Configuration)
|
|
|
55608
56396
|
*/
|
|
55609
56397
|
createScheduledAction(scheduledActionPayloadV2025: ScheduledActionPayloadV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduledActionResponseV2025>>;
|
|
55610
56398
|
/**
|
|
55611
|
-
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
56399
|
+
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects.
|
|
55612
56400
|
* @summary Upload a configuration
|
|
55613
56401
|
* @param {File} data JSON file containing the objects to be imported.
|
|
55614
56402
|
* @param {string} name Name that will be assigned to the uploaded configuration file.
|
|
@@ -55776,7 +56564,7 @@ export declare const ConfigurationHubV2025ApiFactory: (configuration?: Configura
|
|
|
55776
56564
|
*/
|
|
55777
56565
|
createScheduledAction(requestParameters: ConfigurationHubV2025ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ScheduledActionResponseV2025>;
|
|
55778
56566
|
/**
|
|
55779
|
-
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
56567
|
+
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects.
|
|
55780
56568
|
* @summary Upload a configuration
|
|
55781
56569
|
* @param {ConfigurationHubV2025ApiCreateUploadedConfigurationRequest} requestParameters Request parameters.
|
|
55782
56570
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56216,7 +57004,7 @@ export declare class ConfigurationHubV2025Api extends BaseAPI {
|
|
|
56216
57004
|
*/
|
|
56217
57005
|
createScheduledAction(requestParameters: ConfigurationHubV2025ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduledActionResponseV2025, any>>;
|
|
56218
57006
|
/**
|
|
56219
|
-
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
57007
|
+
* This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects.
|
|
56220
57008
|
* @summary Upload a configuration
|
|
56221
57009
|
* @param {ConfigurationHubV2025ApiCreateUploadedConfigurationRequest} requestParameters Request parameters.
|
|
56222
57010
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59046,7 +59834,7 @@ export declare const CustomUserLevelsV2025ApiAxiosParamCreator: (configuration?:
|
|
|
59046
59834
|
/**
|
|
59047
59835
|
* Creates a new custom user level for the tenant.
|
|
59048
59836
|
* @summary Create a custom user level
|
|
59049
|
-
* @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created.
|
|
59837
|
+
* @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59050
59838
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59051
59839
|
* @param {*} [axiosOptions] Override http request option.
|
|
59052
59840
|
* @throws {RequiredError}
|
|
@@ -59082,13 +59870,26 @@ export declare const CustomUserLevelsV2025ApiAxiosParamCreator: (configuration?:
|
|
|
59082
59870
|
* @throws {RequiredError}
|
|
59083
59871
|
*/
|
|
59084
59872
|
listAllAuthorizationRightSets: (xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59873
|
+
/**
|
|
59874
|
+
* List of identities associated with a user level.
|
|
59875
|
+
* @summary List user level identities
|
|
59876
|
+
* @param {string} id The unique identifier of the user level.
|
|
59877
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59878
|
+
* @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response.
|
|
59879
|
+
* @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: **displayName**
|
|
59880
|
+
* @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.
|
|
59881
|
+
* @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.
|
|
59882
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
59883
|
+
* @throws {RequiredError}
|
|
59884
|
+
*/
|
|
59885
|
+
listUserLevelIdentities: (id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59085
59886
|
/**
|
|
59086
59887
|
* Retrieves a list of user levels for the tenant.
|
|
59087
59888
|
* @summary List user levels
|
|
59088
59889
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59089
59890
|
* @param {ListUserLevelsDetailLevelV2025} [detailLevel] Specifies the level of detail for the user levels.
|
|
59090
|
-
* @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: **name**: *co* **owner**: *co* **status**: *eq*
|
|
59091
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created**
|
|
59891
|
+
* @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: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co*
|
|
59892
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner**
|
|
59092
59893
|
* @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.
|
|
59093
59894
|
* @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.
|
|
59094
59895
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59104,11 +59905,20 @@ export declare const CustomUserLevelsV2025ApiAxiosParamCreator: (configuration?:
|
|
|
59104
59905
|
* @throws {RequiredError}
|
|
59105
59906
|
*/
|
|
59106
59907
|
publishCustomUserLevel: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59908
|
+
/**
|
|
59909
|
+
* List of user levels along with the number of identities associated to it.
|
|
59910
|
+
* @summary Count user levels identities
|
|
59911
|
+
* @param {Array<string>} requestBody List of user level ids. Max 50 identifiers can be passed in a single request.
|
|
59912
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59913
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
59914
|
+
* @throws {RequiredError}
|
|
59915
|
+
*/
|
|
59916
|
+
showUserLevelCounts: (requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59107
59917
|
/**
|
|
59108
59918
|
* Updates the details of a specific user level using JSON Patch.
|
|
59109
59919
|
* @summary Update a user level
|
|
59110
59920
|
* @param {string} id The unique identifier of the user level.
|
|
59111
|
-
* @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level.
|
|
59921
|
+
* @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59112
59922
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59113
59923
|
* @param {*} [axiosOptions] Override http request option.
|
|
59114
59924
|
* @throws {RequiredError}
|
|
@@ -59123,7 +59933,7 @@ export declare const CustomUserLevelsV2025ApiFp: (configuration?: Configuration)
|
|
|
59123
59933
|
/**
|
|
59124
59934
|
* Creates a new custom user level for the tenant.
|
|
59125
59935
|
* @summary Create a custom user level
|
|
59126
|
-
* @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created.
|
|
59936
|
+
* @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59127
59937
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59128
59938
|
* @param {*} [axiosOptions] Override http request option.
|
|
59129
59939
|
* @throws {RequiredError}
|
|
@@ -59159,13 +59969,26 @@ export declare const CustomUserLevelsV2025ApiFp: (configuration?: Configuration)
|
|
|
59159
59969
|
* @throws {RequiredError}
|
|
59160
59970
|
*/
|
|
59161
59971
|
listAllAuthorizationRightSets(xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HierarchicalRightSetV2025>>>;
|
|
59972
|
+
/**
|
|
59973
|
+
* List of identities associated with a user level.
|
|
59974
|
+
* @summary List user level identities
|
|
59975
|
+
* @param {string} id The unique identifier of the user level.
|
|
59976
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59977
|
+
* @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response.
|
|
59978
|
+
* @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: **displayName**
|
|
59979
|
+
* @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.
|
|
59980
|
+
* @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.
|
|
59981
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
59982
|
+
* @throws {RequiredError}
|
|
59983
|
+
*/
|
|
59984
|
+
listUserLevelIdentities(id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AuthUserSlimResponseV2025>>>;
|
|
59162
59985
|
/**
|
|
59163
59986
|
* Retrieves a list of user levels for the tenant.
|
|
59164
59987
|
* @summary List user levels
|
|
59165
59988
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59166
59989
|
* @param {ListUserLevelsDetailLevelV2025} [detailLevel] Specifies the level of detail for the user levels.
|
|
59167
|
-
* @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: **name**: *co* **owner**: *co* **status**: *eq*
|
|
59168
|
-
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created**
|
|
59990
|
+
* @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: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co*
|
|
59991
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner**
|
|
59169
59992
|
* @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.
|
|
59170
59993
|
* @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.
|
|
59171
59994
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -59181,11 +60004,20 @@ export declare const CustomUserLevelsV2025ApiFp: (configuration?: Configuration)
|
|
|
59181
60004
|
* @throws {RequiredError}
|
|
59182
60005
|
*/
|
|
59183
60006
|
publishCustomUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserLevelPublishSummaryV2025>>;
|
|
60007
|
+
/**
|
|
60008
|
+
* List of user levels along with the number of identities associated to it.
|
|
60009
|
+
* @summary Count user levels identities
|
|
60010
|
+
* @param {Array<string>} requestBody List of user level ids. Max 50 identifiers can be passed in a single request.
|
|
60011
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
60012
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
60013
|
+
* @throws {RequiredError}
|
|
60014
|
+
*/
|
|
60015
|
+
showUserLevelCounts(requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AuthUserLevelsIdentityCountV2025>>>;
|
|
59184
60016
|
/**
|
|
59185
60017
|
* Updates the details of a specific user level using JSON Patch.
|
|
59186
60018
|
* @summary Update a user level
|
|
59187
60019
|
* @param {string} id The unique identifier of the user level.
|
|
59188
|
-
* @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level.
|
|
60020
|
+
* @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59189
60021
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
59190
60022
|
* @param {*} [axiosOptions] Override http request option.
|
|
59191
60023
|
* @throws {RequiredError}
|
|
@@ -59229,6 +60061,14 @@ export declare const CustomUserLevelsV2025ApiFactory: (configuration?: Configura
|
|
|
59229
60061
|
* @throws {RequiredError}
|
|
59230
60062
|
*/
|
|
59231
60063
|
listAllAuthorizationRightSets(requestParameters?: CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<HierarchicalRightSetV2025>>;
|
|
60064
|
+
/**
|
|
60065
|
+
* List of identities associated with a user level.
|
|
60066
|
+
* @summary List user level identities
|
|
60067
|
+
* @param {CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest} requestParameters Request parameters.
|
|
60068
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
60069
|
+
* @throws {RequiredError}
|
|
60070
|
+
*/
|
|
60071
|
+
listUserLevelIdentities(requestParameters: CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AuthUserSlimResponseV2025>>;
|
|
59232
60072
|
/**
|
|
59233
60073
|
* Retrieves a list of user levels for the tenant.
|
|
59234
60074
|
* @summary List user levels
|
|
@@ -59245,6 +60085,14 @@ export declare const CustomUserLevelsV2025ApiFactory: (configuration?: Configura
|
|
|
59245
60085
|
* @throws {RequiredError}
|
|
59246
60086
|
*/
|
|
59247
60087
|
publishCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UserLevelPublishSummaryV2025>;
|
|
60088
|
+
/**
|
|
60089
|
+
* List of user levels along with the number of identities associated to it.
|
|
60090
|
+
* @summary Count user levels identities
|
|
60091
|
+
* @param {CustomUserLevelsV2025ApiShowUserLevelCountsRequest} requestParameters Request parameters.
|
|
60092
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
60093
|
+
* @throws {RequiredError}
|
|
60094
|
+
*/
|
|
60095
|
+
showUserLevelCounts(requestParameters: CustomUserLevelsV2025ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AuthUserLevelsIdentityCountV2025>>;
|
|
59248
60096
|
/**
|
|
59249
60097
|
* Updates the details of a specific user level using JSON Patch.
|
|
59250
60098
|
* @summary Update a user level
|
|
@@ -59261,7 +60109,7 @@ export declare const CustomUserLevelsV2025ApiFactory: (configuration?: Configura
|
|
|
59261
60109
|
*/
|
|
59262
60110
|
export interface CustomUserLevelsV2025ApiCreateCustomUserLevelRequest {
|
|
59263
60111
|
/**
|
|
59264
|
-
* Payload containing the details of the user level to be created.
|
|
60112
|
+
* Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59265
60113
|
* @type {UserLevelRequestV2025}
|
|
59266
60114
|
* @memberof CustomUserLevelsV2025ApiCreateCustomUserLevel
|
|
59267
60115
|
*/
|
|
@@ -59348,6 +60196,49 @@ export interface CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest {
|
|
|
59348
60196
|
*/
|
|
59349
60197
|
readonly offset?: number;
|
|
59350
60198
|
}
|
|
60199
|
+
/**
|
|
60200
|
+
* Request parameters for listUserLevelIdentities operation in CustomUserLevelsV2025Api.
|
|
60201
|
+
* @export
|
|
60202
|
+
* @interface CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest
|
|
60203
|
+
*/
|
|
60204
|
+
export interface CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest {
|
|
60205
|
+
/**
|
|
60206
|
+
* The unique identifier of the user level.
|
|
60207
|
+
* @type {string}
|
|
60208
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60209
|
+
*/
|
|
60210
|
+
readonly id: string;
|
|
60211
|
+
/**
|
|
60212
|
+
* Use this header to enable this experimental API.
|
|
60213
|
+
* @type {string}
|
|
60214
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60215
|
+
*/
|
|
60216
|
+
readonly xSailPointExperimental?: string;
|
|
60217
|
+
/**
|
|
60218
|
+
* If true, X-Total-Count header with the the total number of identities for this user level will be included in the response.
|
|
60219
|
+
* @type {boolean}
|
|
60220
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60221
|
+
*/
|
|
60222
|
+
readonly count?: boolean;
|
|
60223
|
+
/**
|
|
60224
|
+
* 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: **displayName**
|
|
60225
|
+
* @type {string}
|
|
60226
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60227
|
+
*/
|
|
60228
|
+
readonly sorters?: string;
|
|
60229
|
+
/**
|
|
60230
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
60231
|
+
* @type {number}
|
|
60232
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60233
|
+
*/
|
|
60234
|
+
readonly limit?: number;
|
|
60235
|
+
/**
|
|
60236
|
+
* 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.
|
|
60237
|
+
* @type {number}
|
|
60238
|
+
* @memberof CustomUserLevelsV2025ApiListUserLevelIdentities
|
|
60239
|
+
*/
|
|
60240
|
+
readonly offset?: number;
|
|
60241
|
+
}
|
|
59351
60242
|
/**
|
|
59352
60243
|
* Request parameters for listUserLevels operation in CustomUserLevelsV2025Api.
|
|
59353
60244
|
* @export
|
|
@@ -59367,13 +60258,13 @@ export interface CustomUserLevelsV2025ApiListUserLevelsRequest {
|
|
|
59367
60258
|
*/
|
|
59368
60259
|
readonly detailLevel?: ListUserLevelsDetailLevelV2025;
|
|
59369
60260
|
/**
|
|
59370
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq*
|
|
60261
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co*
|
|
59371
60262
|
* @type {string}
|
|
59372
60263
|
* @memberof CustomUserLevelsV2025ApiListUserLevels
|
|
59373
60264
|
*/
|
|
59374
60265
|
readonly filters?: string;
|
|
59375
60266
|
/**
|
|
59376
|
-
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created**
|
|
60267
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner**
|
|
59377
60268
|
* @type {string}
|
|
59378
60269
|
* @memberof CustomUserLevelsV2025ApiListUserLevels
|
|
59379
60270
|
*/
|
|
@@ -59410,6 +60301,25 @@ export interface CustomUserLevelsV2025ApiPublishCustomUserLevelRequest {
|
|
|
59410
60301
|
*/
|
|
59411
60302
|
readonly xSailPointExperimental?: string;
|
|
59412
60303
|
}
|
|
60304
|
+
/**
|
|
60305
|
+
* Request parameters for showUserLevelCounts operation in CustomUserLevelsV2025Api.
|
|
60306
|
+
* @export
|
|
60307
|
+
* @interface CustomUserLevelsV2025ApiShowUserLevelCountsRequest
|
|
60308
|
+
*/
|
|
60309
|
+
export interface CustomUserLevelsV2025ApiShowUserLevelCountsRequest {
|
|
60310
|
+
/**
|
|
60311
|
+
* List of user level ids. Max 50 identifiers can be passed in a single request.
|
|
60312
|
+
* @type {Array<string>}
|
|
60313
|
+
* @memberof CustomUserLevelsV2025ApiShowUserLevelCounts
|
|
60314
|
+
*/
|
|
60315
|
+
readonly requestBody: Array<string>;
|
|
60316
|
+
/**
|
|
60317
|
+
* Use this header to enable this experimental API.
|
|
60318
|
+
* @type {string}
|
|
60319
|
+
* @memberof CustomUserLevelsV2025ApiShowUserLevelCounts
|
|
60320
|
+
*/
|
|
60321
|
+
readonly xSailPointExperimental?: string;
|
|
60322
|
+
}
|
|
59413
60323
|
/**
|
|
59414
60324
|
* Request parameters for updateUserLevel operation in CustomUserLevelsV2025Api.
|
|
59415
60325
|
* @export
|
|
@@ -59423,7 +60333,7 @@ export interface CustomUserLevelsV2025ApiUpdateUserLevelRequest {
|
|
|
59423
60333
|
*/
|
|
59424
60334
|
readonly id: string;
|
|
59425
60335
|
/**
|
|
59426
|
-
* JSON Patch payload for updating the user level.
|
|
60336
|
+
* JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
|
|
59427
60337
|
* @type {JsonPatchV2025}
|
|
59428
60338
|
* @memberof CustomUserLevelsV2025ApiUpdateUserLevel
|
|
59429
60339
|
*/
|
|
@@ -59478,6 +60388,15 @@ export declare class CustomUserLevelsV2025Api extends BaseAPI {
|
|
|
59478
60388
|
* @memberof CustomUserLevelsV2025Api
|
|
59479
60389
|
*/
|
|
59480
60390
|
listAllAuthorizationRightSets(requestParameters?: CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HierarchicalRightSetV2025[], any>>;
|
|
60391
|
+
/**
|
|
60392
|
+
* List of identities associated with a user level.
|
|
60393
|
+
* @summary List user level identities
|
|
60394
|
+
* @param {CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest} requestParameters Request parameters.
|
|
60395
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
60396
|
+
* @throws {RequiredError}
|
|
60397
|
+
* @memberof CustomUserLevelsV2025Api
|
|
60398
|
+
*/
|
|
60399
|
+
listUserLevelIdentities(requestParameters: CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthUserSlimResponseV2025[], any>>;
|
|
59481
60400
|
/**
|
|
59482
60401
|
* Retrieves a list of user levels for the tenant.
|
|
59483
60402
|
* @summary List user levels
|
|
@@ -59496,6 +60415,15 @@ export declare class CustomUserLevelsV2025Api extends BaseAPI {
|
|
|
59496
60415
|
* @memberof CustomUserLevelsV2025Api
|
|
59497
60416
|
*/
|
|
59498
60417
|
publishCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserLevelPublishSummaryV2025, any>>;
|
|
60418
|
+
/**
|
|
60419
|
+
* List of user levels along with the number of identities associated to it.
|
|
60420
|
+
* @summary Count user levels identities
|
|
60421
|
+
* @param {CustomUserLevelsV2025ApiShowUserLevelCountsRequest} requestParameters Request parameters.
|
|
60422
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
60423
|
+
* @throws {RequiredError}
|
|
60424
|
+
* @memberof CustomUserLevelsV2025Api
|
|
60425
|
+
*/
|
|
60426
|
+
showUserLevelCounts(requestParameters: CustomUserLevelsV2025ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthUserLevelsIdentityCountV2025[], any>>;
|
|
59499
60427
|
/**
|
|
59500
60428
|
* Updates the details of a specific user level using JSON Patch.
|
|
59501
60429
|
* @summary Update a user level
|
|
@@ -60742,7 +61670,7 @@ export declare const EntitlementsV2025ApiAxiosParamCreator: (configuration?: Con
|
|
|
60742
61670
|
*/
|
|
60743
61671
|
resetSourceEntitlements: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60744
61672
|
/**
|
|
60745
|
-
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**`
|
|
61673
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
60746
61674
|
* @summary Bulk update an entitlement list
|
|
60747
61675
|
* @param {EntitlementBulkUpdateRequestV2025} entitlementBulkUpdateRequestV2025
|
|
60748
61676
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -60870,7 +61798,7 @@ export declare const EntitlementsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
60870
61798
|
*/
|
|
60871
61799
|
resetSourceEntitlements(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementSourceResetBaseReferenceDtoV2025>>;
|
|
60872
61800
|
/**
|
|
60873
|
-
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**`
|
|
61801
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
60874
61802
|
* @summary Bulk update an entitlement list
|
|
60875
61803
|
* @param {EntitlementBulkUpdateRequestV2025} entitlementBulkUpdateRequestV2025
|
|
60876
61804
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -60973,7 +61901,7 @@ export declare const EntitlementsV2025ApiFactory: (configuration?: Configuration
|
|
|
60973
61901
|
*/
|
|
60974
61902
|
resetSourceEntitlements(requestParameters: EntitlementsV2025ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementSourceResetBaseReferenceDtoV2025>;
|
|
60975
61903
|
/**
|
|
60976
|
-
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**`
|
|
61904
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
60977
61905
|
* @summary Bulk update an entitlement list
|
|
60978
61906
|
* @param {EntitlementsV2025ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
60979
61907
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61395,7 +62323,7 @@ export declare class EntitlementsV2025Api extends BaseAPI {
|
|
|
61395
62323
|
*/
|
|
61396
62324
|
resetSourceEntitlements(requestParameters: EntitlementsV2025ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementSourceResetBaseReferenceDtoV2025, any>>;
|
|
61397
62325
|
/**
|
|
61398
|
-
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**`
|
|
62326
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
61399
62327
|
* @summary Bulk update an entitlement list
|
|
61400
62328
|
* @param {EntitlementsV2025ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
61401
62329
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -61857,7 +62785,7 @@ export declare const GovernanceGroupsV2025ApiAxiosParamCreator: (configuration?:
|
|
|
61857
62785
|
* This API returns list of Governance Groups
|
|
61858
62786
|
* @summary List governance groups
|
|
61859
62787
|
* @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.
|
|
61860
|
-
* @param {number} [limit]
|
|
62788
|
+
* @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.
|
|
61861
62789
|
* @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.
|
|
61862
62790
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in*
|
|
61863
62791
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description**
|
|
@@ -61968,7 +62896,7 @@ export declare const GovernanceGroupsV2025ApiFp: (configuration?: Configuration)
|
|
|
61968
62896
|
* This API returns list of Governance Groups
|
|
61969
62897
|
* @summary List governance groups
|
|
61970
62898
|
* @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.
|
|
61971
|
-
* @param {number} [limit]
|
|
62899
|
+
* @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.
|
|
61972
62900
|
* @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.
|
|
61973
62901
|
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in*
|
|
61974
62902
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description**
|
|
@@ -62284,7 +63212,7 @@ export interface GovernanceGroupsV2025ApiListWorkgroupsRequest {
|
|
|
62284
63212
|
*/
|
|
62285
63213
|
readonly offset?: number;
|
|
62286
63214
|
/**
|
|
62287
|
-
*
|
|
63215
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
62288
63216
|
* @type {number}
|
|
62289
63217
|
* @memberof GovernanceGroupsV2025ApiListWorkgroups
|
|
62290
63218
|
*/
|
|
@@ -70582,7 +71510,7 @@ export declare const MachineAccountsV2025ApiAxiosParamCreator: (configuration?:
|
|
|
70582
71510
|
* Get all machine account subtypes for a given source.
|
|
70583
71511
|
* @summary Retrieve all subtypes by source
|
|
70584
71512
|
* @param {string} sourceId The ID of the source.
|
|
70585
|
-
* @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)
|
|
71513
|
+
* @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: **displayName**: *eq, sw* **technicalName**: *eq, sw*
|
|
70586
71514
|
* @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: **displayName, technicalName**
|
|
70587
71515
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
70588
71516
|
* @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.
|
|
@@ -70684,7 +71612,7 @@ export declare const MachineAccountsV2025ApiFp: (configuration?: Configuration)
|
|
|
70684
71612
|
* Get all machine account subtypes for a given source.
|
|
70685
71613
|
* @summary Retrieve all subtypes by source
|
|
70686
71614
|
* @param {string} sourceId The ID of the source.
|
|
70687
|
-
* @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)
|
|
71615
|
+
* @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: **displayName**: *eq, sw* **technicalName**: *eq, sw*
|
|
70688
71616
|
* @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: **displayName, technicalName**
|
|
70689
71617
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
70690
71618
|
* @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.
|
|
@@ -70933,7 +71861,7 @@ export interface MachineAccountsV2025ApiListMachineAccountSubtypesRequest {
|
|
|
70933
71861
|
*/
|
|
70934
71862
|
readonly sourceId: string;
|
|
70935
71863
|
/**
|
|
70936
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
71864
|
+
* 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: **displayName**: *eq, sw* **technicalName**: *eq, sw*
|
|
70937
71865
|
* @type {string}
|
|
70938
71866
|
* @memberof MachineAccountsV2025ApiListMachineAccountSubtypes
|
|
70939
71867
|
*/
|
|
@@ -76793,6 +77721,456 @@ export declare class OrgConfigV2025Api extends BaseAPI {
|
|
|
76793
77721
|
*/
|
|
76794
77722
|
patchOrgConfig(requestParameters: OrgConfigV2025ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgConfigV2025, any>>;
|
|
76795
77723
|
}
|
|
77724
|
+
/**
|
|
77725
|
+
* ParameterStorageV2025Api - axios parameter creator
|
|
77726
|
+
* @export
|
|
77727
|
+
*/
|
|
77728
|
+
export declare const ParameterStorageV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
77729
|
+
/**
|
|
77730
|
+
* Add a new parameter.
|
|
77731
|
+
* @summary Add a new parameter.
|
|
77732
|
+
* @param {ParameterStorageNewParameterV2025} [parameterStorageNewParameterV2025] The parameter to add to the store.
|
|
77733
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77734
|
+
* @throws {RequiredError}
|
|
77735
|
+
*/
|
|
77736
|
+
createParameter: (parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77737
|
+
/**
|
|
77738
|
+
* Delete a parameter. Will only delete parameters without existing references.
|
|
77739
|
+
* @summary Delete a parameter.
|
|
77740
|
+
* @param {string} id The ID of the parameter to be deleted.
|
|
77741
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77742
|
+
* @throws {RequiredError}
|
|
77743
|
+
*/
|
|
77744
|
+
deleteParameter: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77745
|
+
/**
|
|
77746
|
+
* Get an attestation document, and perform x25519 handshake to enabled end-to-end encrypted transport of parameter private fields.
|
|
77747
|
+
* @summary Get an attestation document.
|
|
77748
|
+
* @param {string} key Base64Url encoded public key
|
|
77749
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77750
|
+
* @throws {RequiredError}
|
|
77751
|
+
*/
|
|
77752
|
+
getAttestationDocument: (key: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77753
|
+
/**
|
|
77754
|
+
* Get a parameter by ID. This will only return the public fields for the parameter.
|
|
77755
|
+
* @summary Get a specific parameter.
|
|
77756
|
+
* @param {string} id The ID of the parameter to be fetched
|
|
77757
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77758
|
+
* @throws {RequiredError}
|
|
77759
|
+
*/
|
|
77760
|
+
getParameter: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77761
|
+
/**
|
|
77762
|
+
* Get the references for a given parameter.
|
|
77763
|
+
* @summary Get parameter references.
|
|
77764
|
+
* @param {string} id The ID of the parameter which you want to fetch the references for.
|
|
77765
|
+
* @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: **id, consumerId, parameterId, name, usageHint**
|
|
77766
|
+
* @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.
|
|
77767
|
+
* @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.
|
|
77768
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77769
|
+
* @throws {RequiredError}
|
|
77770
|
+
*/
|
|
77771
|
+
getParameterReferences: (id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77772
|
+
/**
|
|
77773
|
+
* Get the specifications for all parameter types. All parameters must conform to this specification document.
|
|
77774
|
+
* @summary Get specifications for parameter types.
|
|
77775
|
+
* @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english.
|
|
77776
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77777
|
+
* @throws {RequiredError}
|
|
77778
|
+
*/
|
|
77779
|
+
getParameterStorageSpecification: (acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77780
|
+
/**
|
|
77781
|
+
* Query a stored parameter.
|
|
77782
|
+
* @summary Query stored parameters.
|
|
77783
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw*
|
|
77784
|
+
* @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: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt**
|
|
77785
|
+
* @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.
|
|
77786
|
+
* @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.
|
|
77787
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77788
|
+
* @throws {RequiredError}
|
|
77789
|
+
*/
|
|
77790
|
+
searchParameters: (filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77791
|
+
/**
|
|
77792
|
+
* Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs.
|
|
77793
|
+
* @summary Update a parameter.
|
|
77794
|
+
* @param {string} id The ID of the parameter to be updated.
|
|
77795
|
+
* @param {ParameterStorageUpdateParameterV2025} [parameterStorageUpdateParameterV2025] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates.
|
|
77796
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77797
|
+
* @throws {RequiredError}
|
|
77798
|
+
*/
|
|
77799
|
+
updateParameter: (id: string, parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77800
|
+
};
|
|
77801
|
+
/**
|
|
77802
|
+
* ParameterStorageV2025Api - functional programming interface
|
|
77803
|
+
* @export
|
|
77804
|
+
*/
|
|
77805
|
+
export declare const ParameterStorageV2025ApiFp: (configuration?: Configuration) => {
|
|
77806
|
+
/**
|
|
77807
|
+
* Add a new parameter.
|
|
77808
|
+
* @summary Add a new parameter.
|
|
77809
|
+
* @param {ParameterStorageNewParameterV2025} [parameterStorageNewParameterV2025] The parameter to add to the store.
|
|
77810
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77811
|
+
* @throws {RequiredError}
|
|
77812
|
+
*/
|
|
77813
|
+
createParameter(parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterStorageParameterV2025>>;
|
|
77814
|
+
/**
|
|
77815
|
+
* Delete a parameter. Will only delete parameters without existing references.
|
|
77816
|
+
* @summary Delete a parameter.
|
|
77817
|
+
* @param {string} id The ID of the parameter to be deleted.
|
|
77818
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77819
|
+
* @throws {RequiredError}
|
|
77820
|
+
*/
|
|
77821
|
+
deleteParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
77822
|
+
/**
|
|
77823
|
+
* Get an attestation document, and perform x25519 handshake to enabled end-to-end encrypted transport of parameter private fields.
|
|
77824
|
+
* @summary Get an attestation document.
|
|
77825
|
+
* @param {string} key Base64Url encoded public key
|
|
77826
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77827
|
+
* @throws {RequiredError}
|
|
77828
|
+
*/
|
|
77829
|
+
getAttestationDocument(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterStorageAttestationDocumentV2025>>;
|
|
77830
|
+
/**
|
|
77831
|
+
* Get a parameter by ID. This will only return the public fields for the parameter.
|
|
77832
|
+
* @summary Get a specific parameter.
|
|
77833
|
+
* @param {string} id The ID of the parameter to be fetched
|
|
77834
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77835
|
+
* @throws {RequiredError}
|
|
77836
|
+
*/
|
|
77837
|
+
getParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterStorageParameterV2025>>;
|
|
77838
|
+
/**
|
|
77839
|
+
* Get the references for a given parameter.
|
|
77840
|
+
* @summary Get parameter references.
|
|
77841
|
+
* @param {string} id The ID of the parameter which you want to fetch the references for.
|
|
77842
|
+
* @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: **id, consumerId, parameterId, name, usageHint**
|
|
77843
|
+
* @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.
|
|
77844
|
+
* @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.
|
|
77845
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77846
|
+
* @throws {RequiredError}
|
|
77847
|
+
*/
|
|
77848
|
+
getParameterReferences(id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ParameterStorageReferenceV2025>>>;
|
|
77849
|
+
/**
|
|
77850
|
+
* Get the specifications for all parameter types. All parameters must conform to this specification document.
|
|
77851
|
+
* @summary Get specifications for parameter types.
|
|
77852
|
+
* @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english.
|
|
77853
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77854
|
+
* @throws {RequiredError}
|
|
77855
|
+
*/
|
|
77856
|
+
getParameterStorageSpecification(acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
77857
|
+
/**
|
|
77858
|
+
* Query a stored parameter.
|
|
77859
|
+
* @summary Query stored parameters.
|
|
77860
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw*
|
|
77861
|
+
* @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: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt**
|
|
77862
|
+
* @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.
|
|
77863
|
+
* @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.
|
|
77864
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77865
|
+
* @throws {RequiredError}
|
|
77866
|
+
*/
|
|
77867
|
+
searchParameters(filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ParameterStorageParameterV2025>>>;
|
|
77868
|
+
/**
|
|
77869
|
+
* Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs.
|
|
77870
|
+
* @summary Update a parameter.
|
|
77871
|
+
* @param {string} id The ID of the parameter to be updated.
|
|
77872
|
+
* @param {ParameterStorageUpdateParameterV2025} [parameterStorageUpdateParameterV2025] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates.
|
|
77873
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77874
|
+
* @throws {RequiredError}
|
|
77875
|
+
*/
|
|
77876
|
+
updateParameter(id: string, parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterStorageParameterV2025>>;
|
|
77877
|
+
};
|
|
77878
|
+
/**
|
|
77879
|
+
* ParameterStorageV2025Api - factory interface
|
|
77880
|
+
* @export
|
|
77881
|
+
*/
|
|
77882
|
+
export declare const ParameterStorageV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
77883
|
+
/**
|
|
77884
|
+
* Add a new parameter.
|
|
77885
|
+
* @summary Add a new parameter.
|
|
77886
|
+
* @param {ParameterStorageV2025ApiCreateParameterRequest} requestParameters Request parameters.
|
|
77887
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77888
|
+
* @throws {RequiredError}
|
|
77889
|
+
*/
|
|
77890
|
+
createParameter(requestParameters?: ParameterStorageV2025ApiCreateParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ParameterStorageParameterV2025>;
|
|
77891
|
+
/**
|
|
77892
|
+
* Delete a parameter. Will only delete parameters without existing references.
|
|
77893
|
+
* @summary Delete a parameter.
|
|
77894
|
+
* @param {ParameterStorageV2025ApiDeleteParameterRequest} requestParameters Request parameters.
|
|
77895
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77896
|
+
* @throws {RequiredError}
|
|
77897
|
+
*/
|
|
77898
|
+
deleteParameter(requestParameters: ParameterStorageV2025ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
77899
|
+
/**
|
|
77900
|
+
* Get an attestation document, and perform x25519 handshake to enabled end-to-end encrypted transport of parameter private fields.
|
|
77901
|
+
* @summary Get an attestation document.
|
|
77902
|
+
* @param {ParameterStorageV2025ApiGetAttestationDocumentRequest} requestParameters Request parameters.
|
|
77903
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77904
|
+
* @throws {RequiredError}
|
|
77905
|
+
*/
|
|
77906
|
+
getAttestationDocument(requestParameters: ParameterStorageV2025ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ParameterStorageAttestationDocumentV2025>;
|
|
77907
|
+
/**
|
|
77908
|
+
* Get a parameter by ID. This will only return the public fields for the parameter.
|
|
77909
|
+
* @summary Get a specific parameter.
|
|
77910
|
+
* @param {ParameterStorageV2025ApiGetParameterRequest} requestParameters Request parameters.
|
|
77911
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77912
|
+
* @throws {RequiredError}
|
|
77913
|
+
*/
|
|
77914
|
+
getParameter(requestParameters: ParameterStorageV2025ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ParameterStorageParameterV2025>;
|
|
77915
|
+
/**
|
|
77916
|
+
* Get the references for a given parameter.
|
|
77917
|
+
* @summary Get parameter references.
|
|
77918
|
+
* @param {ParameterStorageV2025ApiGetParameterReferencesRequest} requestParameters Request parameters.
|
|
77919
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77920
|
+
* @throws {RequiredError}
|
|
77921
|
+
*/
|
|
77922
|
+
getParameterReferences(requestParameters: ParameterStorageV2025ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ParameterStorageReferenceV2025>>;
|
|
77923
|
+
/**
|
|
77924
|
+
* Get the specifications for all parameter types. All parameters must conform to this specification document.
|
|
77925
|
+
* @summary Get specifications for parameter types.
|
|
77926
|
+
* @param {ParameterStorageV2025ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters.
|
|
77927
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77928
|
+
* @throws {RequiredError}
|
|
77929
|
+
*/
|
|
77930
|
+
getParameterStorageSpecification(requestParameters?: ParameterStorageV2025ApiGetParameterStorageSpecificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
77931
|
+
/**
|
|
77932
|
+
* Query a stored parameter.
|
|
77933
|
+
* @summary Query stored parameters.
|
|
77934
|
+
* @param {ParameterStorageV2025ApiSearchParametersRequest} requestParameters Request parameters.
|
|
77935
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77936
|
+
* @throws {RequiredError}
|
|
77937
|
+
*/
|
|
77938
|
+
searchParameters(requestParameters?: ParameterStorageV2025ApiSearchParametersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ParameterStorageParameterV2025>>;
|
|
77939
|
+
/**
|
|
77940
|
+
* Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs.
|
|
77941
|
+
* @summary Update a parameter.
|
|
77942
|
+
* @param {ParameterStorageV2025ApiUpdateParameterRequest} requestParameters Request parameters.
|
|
77943
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
77944
|
+
* @throws {RequiredError}
|
|
77945
|
+
*/
|
|
77946
|
+
updateParameter(requestParameters: ParameterStorageV2025ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ParameterStorageParameterV2025>;
|
|
77947
|
+
};
|
|
77948
|
+
/**
|
|
77949
|
+
* Request parameters for createParameter operation in ParameterStorageV2025Api.
|
|
77950
|
+
* @export
|
|
77951
|
+
* @interface ParameterStorageV2025ApiCreateParameterRequest
|
|
77952
|
+
*/
|
|
77953
|
+
export interface ParameterStorageV2025ApiCreateParameterRequest {
|
|
77954
|
+
/**
|
|
77955
|
+
* The parameter to add to the store.
|
|
77956
|
+
* @type {ParameterStorageNewParameterV2025}
|
|
77957
|
+
* @memberof ParameterStorageV2025ApiCreateParameter
|
|
77958
|
+
*/
|
|
77959
|
+
readonly parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025;
|
|
77960
|
+
}
|
|
77961
|
+
/**
|
|
77962
|
+
* Request parameters for deleteParameter operation in ParameterStorageV2025Api.
|
|
77963
|
+
* @export
|
|
77964
|
+
* @interface ParameterStorageV2025ApiDeleteParameterRequest
|
|
77965
|
+
*/
|
|
77966
|
+
export interface ParameterStorageV2025ApiDeleteParameterRequest {
|
|
77967
|
+
/**
|
|
77968
|
+
* The ID of the parameter to be deleted.
|
|
77969
|
+
* @type {string}
|
|
77970
|
+
* @memberof ParameterStorageV2025ApiDeleteParameter
|
|
77971
|
+
*/
|
|
77972
|
+
readonly id: string;
|
|
77973
|
+
}
|
|
77974
|
+
/**
|
|
77975
|
+
* Request parameters for getAttestationDocument operation in ParameterStorageV2025Api.
|
|
77976
|
+
* @export
|
|
77977
|
+
* @interface ParameterStorageV2025ApiGetAttestationDocumentRequest
|
|
77978
|
+
*/
|
|
77979
|
+
export interface ParameterStorageV2025ApiGetAttestationDocumentRequest {
|
|
77980
|
+
/**
|
|
77981
|
+
* Base64Url encoded public key
|
|
77982
|
+
* @type {string}
|
|
77983
|
+
* @memberof ParameterStorageV2025ApiGetAttestationDocument
|
|
77984
|
+
*/
|
|
77985
|
+
readonly key: string;
|
|
77986
|
+
}
|
|
77987
|
+
/**
|
|
77988
|
+
* Request parameters for getParameter operation in ParameterStorageV2025Api.
|
|
77989
|
+
* @export
|
|
77990
|
+
* @interface ParameterStorageV2025ApiGetParameterRequest
|
|
77991
|
+
*/
|
|
77992
|
+
export interface ParameterStorageV2025ApiGetParameterRequest {
|
|
77993
|
+
/**
|
|
77994
|
+
* The ID of the parameter to be fetched
|
|
77995
|
+
* @type {string}
|
|
77996
|
+
* @memberof ParameterStorageV2025ApiGetParameter
|
|
77997
|
+
*/
|
|
77998
|
+
readonly id: string;
|
|
77999
|
+
}
|
|
78000
|
+
/**
|
|
78001
|
+
* Request parameters for getParameterReferences operation in ParameterStorageV2025Api.
|
|
78002
|
+
* @export
|
|
78003
|
+
* @interface ParameterStorageV2025ApiGetParameterReferencesRequest
|
|
78004
|
+
*/
|
|
78005
|
+
export interface ParameterStorageV2025ApiGetParameterReferencesRequest {
|
|
78006
|
+
/**
|
|
78007
|
+
* The ID of the parameter which you want to fetch the references for.
|
|
78008
|
+
* @type {string}
|
|
78009
|
+
* @memberof ParameterStorageV2025ApiGetParameterReferences
|
|
78010
|
+
*/
|
|
78011
|
+
readonly id: string;
|
|
78012
|
+
/**
|
|
78013
|
+
* 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: **id, consumerId, parameterId, name, usageHint**
|
|
78014
|
+
* @type {string}
|
|
78015
|
+
* @memberof ParameterStorageV2025ApiGetParameterReferences
|
|
78016
|
+
*/
|
|
78017
|
+
readonly sorters?: string;
|
|
78018
|
+
/**
|
|
78019
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
78020
|
+
* @type {number}
|
|
78021
|
+
* @memberof ParameterStorageV2025ApiGetParameterReferences
|
|
78022
|
+
*/
|
|
78023
|
+
readonly limit?: number;
|
|
78024
|
+
/**
|
|
78025
|
+
* 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.
|
|
78026
|
+
* @type {number}
|
|
78027
|
+
* @memberof ParameterStorageV2025ApiGetParameterReferences
|
|
78028
|
+
*/
|
|
78029
|
+
readonly offset?: number;
|
|
78030
|
+
}
|
|
78031
|
+
/**
|
|
78032
|
+
* Request parameters for getParameterStorageSpecification operation in ParameterStorageV2025Api.
|
|
78033
|
+
* @export
|
|
78034
|
+
* @interface ParameterStorageV2025ApiGetParameterStorageSpecificationRequest
|
|
78035
|
+
*/
|
|
78036
|
+
export interface ParameterStorageV2025ApiGetParameterStorageSpecificationRequest {
|
|
78037
|
+
/**
|
|
78038
|
+
* The i18n internationalization code for the language that the spec is in. Defaults to english.
|
|
78039
|
+
* @type {string}
|
|
78040
|
+
* @memberof ParameterStorageV2025ApiGetParameterStorageSpecification
|
|
78041
|
+
*/
|
|
78042
|
+
readonly acceptLanguage?: string;
|
|
78043
|
+
}
|
|
78044
|
+
/**
|
|
78045
|
+
* Request parameters for searchParameters operation in ParameterStorageV2025Api.
|
|
78046
|
+
* @export
|
|
78047
|
+
* @interface ParameterStorageV2025ApiSearchParametersRequest
|
|
78048
|
+
*/
|
|
78049
|
+
export interface ParameterStorageV2025ApiSearchParametersRequest {
|
|
78050
|
+
/**
|
|
78051
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw*
|
|
78052
|
+
* @type {string}
|
|
78053
|
+
* @memberof ParameterStorageV2025ApiSearchParameters
|
|
78054
|
+
*/
|
|
78055
|
+
readonly filters?: string;
|
|
78056
|
+
/**
|
|
78057
|
+
* 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: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt**
|
|
78058
|
+
* @type {string}
|
|
78059
|
+
* @memberof ParameterStorageV2025ApiSearchParameters
|
|
78060
|
+
*/
|
|
78061
|
+
readonly sorters?: string;
|
|
78062
|
+
/**
|
|
78063
|
+
* 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.
|
|
78064
|
+
* @type {number}
|
|
78065
|
+
* @memberof ParameterStorageV2025ApiSearchParameters
|
|
78066
|
+
*/
|
|
78067
|
+
readonly offset?: number;
|
|
78068
|
+
/**
|
|
78069
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
78070
|
+
* @type {number}
|
|
78071
|
+
* @memberof ParameterStorageV2025ApiSearchParameters
|
|
78072
|
+
*/
|
|
78073
|
+
readonly limit?: number;
|
|
78074
|
+
}
|
|
78075
|
+
/**
|
|
78076
|
+
* Request parameters for updateParameter operation in ParameterStorageV2025Api.
|
|
78077
|
+
* @export
|
|
78078
|
+
* @interface ParameterStorageV2025ApiUpdateParameterRequest
|
|
78079
|
+
*/
|
|
78080
|
+
export interface ParameterStorageV2025ApiUpdateParameterRequest {
|
|
78081
|
+
/**
|
|
78082
|
+
* The ID of the parameter to be updated.
|
|
78083
|
+
* @type {string}
|
|
78084
|
+
* @memberof ParameterStorageV2025ApiUpdateParameter
|
|
78085
|
+
*/
|
|
78086
|
+
readonly id: string;
|
|
78087
|
+
/**
|
|
78088
|
+
* The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates.
|
|
78089
|
+
* @type {ParameterStorageUpdateParameterV2025}
|
|
78090
|
+
* @memberof ParameterStorageV2025ApiUpdateParameter
|
|
78091
|
+
*/
|
|
78092
|
+
readonly parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025;
|
|
78093
|
+
}
|
|
78094
|
+
/**
|
|
78095
|
+
* ParameterStorageV2025Api - object-oriented interface
|
|
78096
|
+
* @export
|
|
78097
|
+
* @class ParameterStorageV2025Api
|
|
78098
|
+
* @extends {BaseAPI}
|
|
78099
|
+
*/
|
|
78100
|
+
export declare class ParameterStorageV2025Api extends BaseAPI {
|
|
78101
|
+
/**
|
|
78102
|
+
* Add a new parameter.
|
|
78103
|
+
* @summary Add a new parameter.
|
|
78104
|
+
* @param {ParameterStorageV2025ApiCreateParameterRequest} requestParameters Request parameters.
|
|
78105
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78106
|
+
* @throws {RequiredError}
|
|
78107
|
+
* @memberof ParameterStorageV2025Api
|
|
78108
|
+
*/
|
|
78109
|
+
createParameter(requestParameters?: ParameterStorageV2025ApiCreateParameterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageParameterV2025, any>>;
|
|
78110
|
+
/**
|
|
78111
|
+
* Delete a parameter. Will only delete parameters without existing references.
|
|
78112
|
+
* @summary Delete a parameter.
|
|
78113
|
+
* @param {ParameterStorageV2025ApiDeleteParameterRequest} requestParameters Request parameters.
|
|
78114
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78115
|
+
* @throws {RequiredError}
|
|
78116
|
+
* @memberof ParameterStorageV2025Api
|
|
78117
|
+
*/
|
|
78118
|
+
deleteParameter(requestParameters: ParameterStorageV2025ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
78119
|
+
/**
|
|
78120
|
+
* Get an attestation document, and perform x25519 handshake to enabled end-to-end encrypted transport of parameter private fields.
|
|
78121
|
+
* @summary Get an attestation document.
|
|
78122
|
+
* @param {ParameterStorageV2025ApiGetAttestationDocumentRequest} requestParameters Request parameters.
|
|
78123
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78124
|
+
* @throws {RequiredError}
|
|
78125
|
+
* @memberof ParameterStorageV2025Api
|
|
78126
|
+
*/
|
|
78127
|
+
getAttestationDocument(requestParameters: ParameterStorageV2025ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageAttestationDocumentV2025, any>>;
|
|
78128
|
+
/**
|
|
78129
|
+
* Get a parameter by ID. This will only return the public fields for the parameter.
|
|
78130
|
+
* @summary Get a specific parameter.
|
|
78131
|
+
* @param {ParameterStorageV2025ApiGetParameterRequest} requestParameters Request parameters.
|
|
78132
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78133
|
+
* @throws {RequiredError}
|
|
78134
|
+
* @memberof ParameterStorageV2025Api
|
|
78135
|
+
*/
|
|
78136
|
+
getParameter(requestParameters: ParameterStorageV2025ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageParameterV2025, any>>;
|
|
78137
|
+
/**
|
|
78138
|
+
* Get the references for a given parameter.
|
|
78139
|
+
* @summary Get parameter references.
|
|
78140
|
+
* @param {ParameterStorageV2025ApiGetParameterReferencesRequest} requestParameters Request parameters.
|
|
78141
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78142
|
+
* @throws {RequiredError}
|
|
78143
|
+
* @memberof ParameterStorageV2025Api
|
|
78144
|
+
*/
|
|
78145
|
+
getParameterReferences(requestParameters: ParameterStorageV2025ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageReferenceV2025[], any>>;
|
|
78146
|
+
/**
|
|
78147
|
+
* Get the specifications for all parameter types. All parameters must conform to this specification document.
|
|
78148
|
+
* @summary Get specifications for parameter types.
|
|
78149
|
+
* @param {ParameterStorageV2025ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters.
|
|
78150
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78151
|
+
* @throws {RequiredError}
|
|
78152
|
+
* @memberof ParameterStorageV2025Api
|
|
78153
|
+
*/
|
|
78154
|
+
getParameterStorageSpecification(requestParameters?: ParameterStorageV2025ApiGetParameterStorageSpecificationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
78155
|
+
/**
|
|
78156
|
+
* Query a stored parameter.
|
|
78157
|
+
* @summary Query stored parameters.
|
|
78158
|
+
* @param {ParameterStorageV2025ApiSearchParametersRequest} requestParameters Request parameters.
|
|
78159
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78160
|
+
* @throws {RequiredError}
|
|
78161
|
+
* @memberof ParameterStorageV2025Api
|
|
78162
|
+
*/
|
|
78163
|
+
searchParameters(requestParameters?: ParameterStorageV2025ApiSearchParametersRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageParameterV2025[], any>>;
|
|
78164
|
+
/**
|
|
78165
|
+
* Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs.
|
|
78166
|
+
* @summary Update a parameter.
|
|
78167
|
+
* @param {ParameterStorageV2025ApiUpdateParameterRequest} requestParameters Request parameters.
|
|
78168
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
78169
|
+
* @throws {RequiredError}
|
|
78170
|
+
* @memberof ParameterStorageV2025Api
|
|
78171
|
+
*/
|
|
78172
|
+
updateParameter(requestParameters: ParameterStorageV2025ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParameterStorageParameterV2025, any>>;
|
|
78173
|
+
}
|
|
76796
78174
|
/**
|
|
76797
78175
|
* PasswordConfigurationV2025Api - axios parameter creator
|
|
76798
78176
|
* @export
|
|
@@ -81716,7 +83094,7 @@ export declare class SODViolationsV2025Api extends BaseAPI {
|
|
|
81716
83094
|
*/
|
|
81717
83095
|
export declare const SPConfigV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
81718
83096
|
/**
|
|
81719
|
-
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83097
|
+
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81720
83098
|
* @summary Initiates configuration objects export job
|
|
81721
83099
|
* @param {ExportPayloadV2025} exportPayloadV2025 Export options control what will be included in the export.
|
|
81722
83100
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81748,7 +83126,7 @@ export declare const SPConfigV2025ApiAxiosParamCreator: (configuration?: Configu
|
|
|
81748
83126
|
*/
|
|
81749
83127
|
getSpConfigImport: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81750
83128
|
/**
|
|
81751
|
-
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83129
|
+
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\'
|
|
81752
83130
|
* @summary Get import job status
|
|
81753
83131
|
* @param {string} id The ID of the import job whose status will be returned.
|
|
81754
83132
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81756,7 +83134,7 @@ export declare const SPConfigV2025ApiAxiosParamCreator: (configuration?: Configu
|
|
|
81756
83134
|
*/
|
|
81757
83135
|
getSpConfigImportStatus: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81758
83136
|
/**
|
|
81759
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83137
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81760
83138
|
* @summary Initiates configuration objects import job
|
|
81761
83139
|
* @param {File} data JSON file containing the objects to be imported.
|
|
81762
83140
|
* @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
|
@@ -81779,7 +83157,7 @@ export declare const SPConfigV2025ApiAxiosParamCreator: (configuration?: Configu
|
|
|
81779
83157
|
*/
|
|
81780
83158
|
export declare const SPConfigV2025ApiFp: (configuration?: Configuration) => {
|
|
81781
83159
|
/**
|
|
81782
|
-
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83160
|
+
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81783
83161
|
* @summary Initiates configuration objects export job
|
|
81784
83162
|
* @param {ExportPayloadV2025} exportPayloadV2025 Export options control what will be included in the export.
|
|
81785
83163
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81811,7 +83189,7 @@ export declare const SPConfigV2025ApiFp: (configuration?: Configuration) => {
|
|
|
81811
83189
|
*/
|
|
81812
83190
|
getSpConfigImport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpConfigImportResultsV2025>>;
|
|
81813
83191
|
/**
|
|
81814
|
-
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83192
|
+
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\'
|
|
81815
83193
|
* @summary Get import job status
|
|
81816
83194
|
* @param {string} id The ID of the import job whose status will be returned.
|
|
81817
83195
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81819,7 +83197,7 @@ export declare const SPConfigV2025ApiFp: (configuration?: Configuration) => {
|
|
|
81819
83197
|
*/
|
|
81820
83198
|
getSpConfigImportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpConfigImportJobStatusV2025>>;
|
|
81821
83199
|
/**
|
|
81822
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83200
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81823
83201
|
* @summary Initiates configuration objects import job
|
|
81824
83202
|
* @param {File} data JSON file containing the objects to be imported.
|
|
81825
83203
|
* @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
|
@@ -81842,7 +83220,7 @@ export declare const SPConfigV2025ApiFp: (configuration?: Configuration) => {
|
|
|
81842
83220
|
*/
|
|
81843
83221
|
export declare const SPConfigV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
81844
83222
|
/**
|
|
81845
|
-
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83223
|
+
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81846
83224
|
* @summary Initiates configuration objects export job
|
|
81847
83225
|
* @param {SPConfigV2025ApiExportSpConfigRequest} requestParameters Request parameters.
|
|
81848
83226
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81874,7 +83252,7 @@ export declare const SPConfigV2025ApiFactory: (configuration?: Configuration, ba
|
|
|
81874
83252
|
*/
|
|
81875
83253
|
getSpConfigImport(requestParameters: SPConfigV2025ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SpConfigImportResultsV2025>;
|
|
81876
83254
|
/**
|
|
81877
|
-
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83255
|
+
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\'
|
|
81878
83256
|
* @summary Get import job status
|
|
81879
83257
|
* @param {SPConfigV2025ApiGetSpConfigImportStatusRequest} requestParameters Request parameters.
|
|
81880
83258
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81882,7 +83260,7 @@ export declare const SPConfigV2025ApiFactory: (configuration?: Configuration, ba
|
|
|
81882
83260
|
*/
|
|
81883
83261
|
getSpConfigImportStatus(requestParameters: SPConfigV2025ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SpConfigImportJobStatusV2025>;
|
|
81884
83262
|
/**
|
|
81885
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83263
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81886
83264
|
* @summary Initiates configuration objects import job
|
|
81887
83265
|
* @param {SPConfigV2025ApiImportSpConfigRequest} requestParameters Request parameters.
|
|
81888
83266
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81995,7 +83373,7 @@ export interface SPConfigV2025ApiImportSpConfigRequest {
|
|
|
81995
83373
|
*/
|
|
81996
83374
|
export declare class SPConfigV2025Api extends BaseAPI {
|
|
81997
83375
|
/**
|
|
81998
|
-
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83376
|
+
* This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
81999
83377
|
* @summary Initiates configuration objects export job
|
|
82000
83378
|
* @param {SPConfigV2025ApiExportSpConfigRequest} requestParameters Request parameters.
|
|
82001
83379
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -82031,7 +83409,7 @@ export declare class SPConfigV2025Api extends BaseAPI {
|
|
|
82031
83409
|
*/
|
|
82032
83410
|
getSpConfigImport(requestParameters: SPConfigV2025ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SpConfigImportResultsV2025, any>>;
|
|
82033
83411
|
/**
|
|
82034
|
-
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83412
|
+
* \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\'
|
|
82035
83413
|
* @summary Get import job status
|
|
82036
83414
|
* @param {SPConfigV2025ApiGetSpConfigImportStatusRequest} requestParameters Request parameters.
|
|
82037
83415
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -82040,7 +83418,7 @@ export declare class SPConfigV2025Api extends BaseAPI {
|
|
|
82040
83418
|
*/
|
|
82041
83419
|
getSpConfigImportStatus(requestParameters: SPConfigV2025ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SpConfigImportJobStatusV2025, any>>;
|
|
82042
83420
|
/**
|
|
82043
|
-
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/
|
|
83421
|
+
* This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).
|
|
82044
83422
|
* @summary Initiates configuration objects import job
|
|
82045
83423
|
* @param {SPConfigV2025ApiImportSpConfigRequest} requestParameters Request parameters.
|
|
82046
83424
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -84267,7 +85645,7 @@ export declare class SourceUsagesV2025Api extends BaseAPI {
|
|
|
84267
85645
|
*/
|
|
84268
85646
|
export declare const SourcesV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
84269
85647
|
/**
|
|
84270
|
-
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
85648
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
84271
85649
|
* @summary Create provisioning policy
|
|
84272
85650
|
* @param {string} sourceId The Source id
|
|
84273
85651
|
* @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025
|
|
@@ -84586,7 +85964,7 @@ export declare const SourcesV2025ApiAxiosParamCreator: (configuration?: Configur
|
|
|
84586
85964
|
*/
|
|
84587
85965
|
putNativeChangeDetectionConfig: (id: string, nativeChangeDetectionConfigV2025: NativeChangeDetectionConfigV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84588
85966
|
/**
|
|
84589
|
-
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
85967
|
+
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
84590
85968
|
* @summary Update provisioning policy by usagetype
|
|
84591
85969
|
* @param {string} sourceId The Source ID.
|
|
84592
85970
|
* @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
@@ -84677,7 +86055,7 @@ export declare const SourcesV2025ApiAxiosParamCreator: (configuration?: Configur
|
|
|
84677
86055
|
*/
|
|
84678
86056
|
updateProvisioningPoliciesInBulk: (sourceId: string, provisioningPolicyDtoV2025: Array<ProvisioningPolicyDtoV2025>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84679
86057
|
/**
|
|
84680
|
-
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86058
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
84681
86059
|
* @summary Partial update of provisioning policy
|
|
84682
86060
|
* @param {string} sourceId The Source id.
|
|
84683
86061
|
* @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
@@ -84731,7 +86109,7 @@ export declare const SourcesV2025ApiAxiosParamCreator: (configuration?: Configur
|
|
|
84731
86109
|
*/
|
|
84732
86110
|
export declare const SourcesV2025ApiFp: (configuration?: Configuration) => {
|
|
84733
86111
|
/**
|
|
84734
|
-
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86112
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
84735
86113
|
* @summary Create provisioning policy
|
|
84736
86114
|
* @param {string} sourceId The Source id
|
|
84737
86115
|
* @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025
|
|
@@ -85050,7 +86428,7 @@ export declare const SourcesV2025ApiFp: (configuration?: Configuration) => {
|
|
|
85050
86428
|
*/
|
|
85051
86429
|
putNativeChangeDetectionConfig(id: string, nativeChangeDetectionConfigV2025: NativeChangeDetectionConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NativeChangeDetectionConfigV2025>>;
|
|
85052
86430
|
/**
|
|
85053
|
-
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86431
|
+
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
85054
86432
|
* @summary Update provisioning policy by usagetype
|
|
85055
86433
|
* @param {string} sourceId The Source ID.
|
|
85056
86434
|
* @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
@@ -85141,7 +86519,7 @@ export declare const SourcesV2025ApiFp: (configuration?: Configuration) => {
|
|
|
85141
86519
|
*/
|
|
85142
86520
|
updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDtoV2025: Array<ProvisioningPolicyDtoV2025>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProvisioningPolicyDtoV2025>>>;
|
|
85143
86521
|
/**
|
|
85144
|
-
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86522
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
85145
86523
|
* @summary Partial update of provisioning policy
|
|
85146
86524
|
* @param {string} sourceId The Source id.
|
|
85147
86525
|
* @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
@@ -85195,7 +86573,7 @@ export declare const SourcesV2025ApiFp: (configuration?: Configuration) => {
|
|
|
85195
86573
|
*/
|
|
85196
86574
|
export declare const SourcesV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
85197
86575
|
/**
|
|
85198
|
-
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86576
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
85199
86577
|
* @summary Create provisioning policy
|
|
85200
86578
|
* @param {SourcesV2025ApiCreateProvisioningPolicyRequest} requestParameters Request parameters.
|
|
85201
86579
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -85483,7 +86861,7 @@ export declare const SourcesV2025ApiFactory: (configuration?: Configuration, bas
|
|
|
85483
86861
|
*/
|
|
85484
86862
|
putNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<NativeChangeDetectionConfigV2025>;
|
|
85485
86863
|
/**
|
|
85486
|
-
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86864
|
+
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
85487
86865
|
* @summary Update provisioning policy by usagetype
|
|
85488
86866
|
* @param {SourcesV2025ApiPutProvisioningPolicyRequest} requestParameters Request parameters.
|
|
85489
86867
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -85563,7 +86941,7 @@ export declare const SourcesV2025ApiFactory: (configuration?: Configuration, bas
|
|
|
85563
86941
|
*/
|
|
85564
86942
|
updateProvisioningPoliciesInBulk(requestParameters: SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ProvisioningPolicyDtoV2025>>;
|
|
85565
86943
|
/**
|
|
85566
|
-
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
86944
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
85567
86945
|
* @summary Partial update of provisioning policy
|
|
85568
86946
|
* @param {SourcesV2025ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters.
|
|
85569
86947
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -86574,7 +87952,7 @@ export interface SourcesV2025ApiUpdateSourceSchemaRequest {
|
|
|
86574
87952
|
*/
|
|
86575
87953
|
export declare class SourcesV2025Api extends BaseAPI {
|
|
86576
87954
|
/**
|
|
86577
|
-
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
87955
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
86578
87956
|
* @summary Create provisioning policy
|
|
86579
87957
|
* @param {SourcesV2025ApiCreateProvisioningPolicyRequest} requestParameters Request parameters.
|
|
86580
87958
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -86898,7 +88276,7 @@ export declare class SourcesV2025Api extends BaseAPI {
|
|
|
86898
88276
|
*/
|
|
86899
88277
|
putNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NativeChangeDetectionConfigV2025, any>>;
|
|
86900
88278
|
/**
|
|
86901
|
-
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
88279
|
+
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
86902
88280
|
* @summary Update provisioning policy by usagetype
|
|
86903
88281
|
* @param {SourcesV2025ApiPutProvisioningPolicyRequest} requestParameters Request parameters.
|
|
86904
88282
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -86988,7 +88366,7 @@ export declare class SourcesV2025Api extends BaseAPI {
|
|
|
86988
88366
|
*/
|
|
86989
88367
|
updateProvisioningPoliciesInBulk(requestParameters: SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvisioningPolicyDtoV2025[], any>>;
|
|
86990
88368
|
/**
|
|
86991
|
-
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/
|
|
88369
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
86992
88370
|
* @summary Partial update of provisioning policy
|
|
86993
88371
|
* @param {SourcesV2025ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters.
|
|
86994
88372
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87566,7 +88944,7 @@ export declare const TaggedObjectsV2025ApiAxiosParamCreator: (configuration?: Co
|
|
|
87566
88944
|
*/
|
|
87567
88945
|
getTaggedObject: (type: GetTaggedObjectTypeV2025, id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87568
88946
|
/**
|
|
87569
|
-
* This API returns a list of all tagged objects.
|
|
88947
|
+
* This API returns a list of all tagged objects.
|
|
87570
88948
|
* @summary List tagged objects
|
|
87571
88949
|
* @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.
|
|
87572
88950
|
* @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.
|
|
@@ -87577,7 +88955,7 @@ export declare const TaggedObjectsV2025ApiAxiosParamCreator: (configuration?: Co
|
|
|
87577
88955
|
*/
|
|
87578
88956
|
listTaggedObjects: (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87579
88957
|
/**
|
|
87580
|
-
* This API returns a list of all tagged objects by type.
|
|
88958
|
+
* This API returns a list of all tagged objects by type.
|
|
87581
88959
|
* @summary List tagged objects by type
|
|
87582
88960
|
* @param {ListTaggedObjectsByTypeTypeV2025} type The type of tagged object to retrieve.
|
|
87583
88961
|
* @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.
|
|
@@ -87599,7 +88977,7 @@ export declare const TaggedObjectsV2025ApiAxiosParamCreator: (configuration?: Co
|
|
|
87599
88977
|
*/
|
|
87600
88978
|
putTaggedObject: (type: PutTaggedObjectTypeV2025, id: string, taggedObjectV2025: TaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87601
88979
|
/**
|
|
87602
|
-
* This adds a tag to an object.
|
|
88980
|
+
* This adds a tag to an object.
|
|
87603
88981
|
* @summary Add tag to object
|
|
87604
88982
|
* @param {TaggedObjectV2025} taggedObjectV2025
|
|
87605
88983
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87647,7 +89025,7 @@ export declare const TaggedObjectsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
87647
89025
|
*/
|
|
87648
89026
|
getTaggedObject(type: GetTaggedObjectTypeV2025, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaggedObjectV2025>>;
|
|
87649
89027
|
/**
|
|
87650
|
-
* This API returns a list of all tagged objects.
|
|
89028
|
+
* This API returns a list of all tagged objects.
|
|
87651
89029
|
* @summary List tagged objects
|
|
87652
89030
|
* @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.
|
|
87653
89031
|
* @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.
|
|
@@ -87658,7 +89036,7 @@ export declare const TaggedObjectsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
87658
89036
|
*/
|
|
87659
89037
|
listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaggedObjectV2025>>>;
|
|
87660
89038
|
/**
|
|
87661
|
-
* This API returns a list of all tagged objects by type.
|
|
89039
|
+
* This API returns a list of all tagged objects by type.
|
|
87662
89040
|
* @summary List tagged objects by type
|
|
87663
89041
|
* @param {ListTaggedObjectsByTypeTypeV2025} type The type of tagged object to retrieve.
|
|
87664
89042
|
* @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.
|
|
@@ -87680,7 +89058,7 @@ export declare const TaggedObjectsV2025ApiFp: (configuration?: Configuration) =>
|
|
|
87680
89058
|
*/
|
|
87681
89059
|
putTaggedObject(type: PutTaggedObjectTypeV2025, id: string, taggedObjectV2025: TaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaggedObjectV2025>>;
|
|
87682
89060
|
/**
|
|
87683
|
-
* This adds a tag to an object.
|
|
89061
|
+
* This adds a tag to an object.
|
|
87684
89062
|
* @summary Add tag to object
|
|
87685
89063
|
* @param {TaggedObjectV2025} taggedObjectV2025
|
|
87686
89064
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87726,7 +89104,7 @@ export declare const TaggedObjectsV2025ApiFactory: (configuration?: Configuratio
|
|
|
87726
89104
|
*/
|
|
87727
89105
|
getTaggedObject(requestParameters: TaggedObjectsV2025ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaggedObjectV2025>;
|
|
87728
89106
|
/**
|
|
87729
|
-
* This API returns a list of all tagged objects.
|
|
89107
|
+
* This API returns a list of all tagged objects.
|
|
87730
89108
|
* @summary List tagged objects
|
|
87731
89109
|
* @param {TaggedObjectsV2025ApiListTaggedObjectsRequest} requestParameters Request parameters.
|
|
87732
89110
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87734,7 +89112,7 @@ export declare const TaggedObjectsV2025ApiFactory: (configuration?: Configuratio
|
|
|
87734
89112
|
*/
|
|
87735
89113
|
listTaggedObjects(requestParameters?: TaggedObjectsV2025ApiListTaggedObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaggedObjectV2025>>;
|
|
87736
89114
|
/**
|
|
87737
|
-
* This API returns a list of all tagged objects by type.
|
|
89115
|
+
* This API returns a list of all tagged objects by type.
|
|
87738
89116
|
* @summary List tagged objects by type
|
|
87739
89117
|
* @param {TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters.
|
|
87740
89118
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87750,7 +89128,7 @@ export declare const TaggedObjectsV2025ApiFactory: (configuration?: Configuratio
|
|
|
87750
89128
|
*/
|
|
87751
89129
|
putTaggedObject(requestParameters: TaggedObjectsV2025ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaggedObjectV2025>;
|
|
87752
89130
|
/**
|
|
87753
|
-
* This adds a tag to an object.
|
|
89131
|
+
* This adds a tag to an object.
|
|
87754
89132
|
* @summary Add tag to object
|
|
87755
89133
|
* @param {TaggedObjectsV2025ApiSetTagToObjectRequest} requestParameters Request parameters.
|
|
87756
89134
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87971,7 +89349,7 @@ export declare class TaggedObjectsV2025Api extends BaseAPI {
|
|
|
87971
89349
|
*/
|
|
87972
89350
|
getTaggedObject(requestParameters: TaggedObjectsV2025ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaggedObjectV2025, any>>;
|
|
87973
89351
|
/**
|
|
87974
|
-
* This API returns a list of all tagged objects.
|
|
89352
|
+
* This API returns a list of all tagged objects.
|
|
87975
89353
|
* @summary List tagged objects
|
|
87976
89354
|
* @param {TaggedObjectsV2025ApiListTaggedObjectsRequest} requestParameters Request parameters.
|
|
87977
89355
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87980,7 +89358,7 @@ export declare class TaggedObjectsV2025Api extends BaseAPI {
|
|
|
87980
89358
|
*/
|
|
87981
89359
|
listTaggedObjects(requestParameters?: TaggedObjectsV2025ApiListTaggedObjectsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaggedObjectV2025[], any>>;
|
|
87982
89360
|
/**
|
|
87983
|
-
* This API returns a list of all tagged objects by type.
|
|
89361
|
+
* This API returns a list of all tagged objects by type.
|
|
87984
89362
|
* @summary List tagged objects by type
|
|
87985
89363
|
* @param {TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters.
|
|
87986
89364
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -87998,7 +89376,7 @@ export declare class TaggedObjectsV2025Api extends BaseAPI {
|
|
|
87998
89376
|
*/
|
|
87999
89377
|
putTaggedObject(requestParameters: TaggedObjectsV2025ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaggedObjectV2025, any>>;
|
|
88000
89378
|
/**
|
|
88001
|
-
* This adds a tag to an object.
|
|
89379
|
+
* This adds a tag to an object.
|
|
88002
89380
|
* @summary Add tag to object
|
|
88003
89381
|
* @param {TaggedObjectsV2025ApiSetTagToObjectRequest} requestParameters Request parameters.
|
|
88004
89382
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -89931,153 +91309,6 @@ export declare class UIMetadataV2025Api extends BaseAPI {
|
|
|
89931
91309
|
*/
|
|
89932
91310
|
setTenantUiMetadata(requestParameters: UIMetadataV2025ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TenantUiMetadataItemResponseV2025, any>>;
|
|
89933
91311
|
}
|
|
89934
|
-
/**
|
|
89935
|
-
* VendorConnectorMappingsV2025Api - axios parameter creator
|
|
89936
|
-
* @export
|
|
89937
|
-
*/
|
|
89938
|
-
export declare const VendorConnectorMappingsV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
89939
|
-
/**
|
|
89940
|
-
* Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
|
|
89941
|
-
* @summary Create vendor connector mapping
|
|
89942
|
-
* @param {VendorConnectorMappingV2025} vendorConnectorMappingV2025
|
|
89943
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89944
|
-
* @throws {RequiredError}
|
|
89945
|
-
*/
|
|
89946
|
-
createVendorConnectorMapping: (vendorConnectorMappingV2025: VendorConnectorMappingV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89947
|
-
/**
|
|
89948
|
-
* Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
|
|
89949
|
-
* @summary Delete vendor connector mapping
|
|
89950
|
-
* @param {VendorConnectorMappingV2025} vendorConnectorMappingV2025
|
|
89951
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89952
|
-
* @throws {RequiredError}
|
|
89953
|
-
*/
|
|
89954
|
-
deleteVendorConnectorMapping: (vendorConnectorMappingV2025: VendorConnectorMappingV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89955
|
-
/**
|
|
89956
|
-
* Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
|
|
89957
|
-
* @summary List vendor connector mappings
|
|
89958
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89959
|
-
* @throws {RequiredError}
|
|
89960
|
-
*/
|
|
89961
|
-
getVendorConnectorMappings: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89962
|
-
};
|
|
89963
|
-
/**
|
|
89964
|
-
* VendorConnectorMappingsV2025Api - functional programming interface
|
|
89965
|
-
* @export
|
|
89966
|
-
*/
|
|
89967
|
-
export declare const VendorConnectorMappingsV2025ApiFp: (configuration?: Configuration) => {
|
|
89968
|
-
/**
|
|
89969
|
-
* Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
|
|
89970
|
-
* @summary Create vendor connector mapping
|
|
89971
|
-
* @param {VendorConnectorMappingV2025} vendorConnectorMappingV2025
|
|
89972
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89973
|
-
* @throws {RequiredError}
|
|
89974
|
-
*/
|
|
89975
|
-
createVendorConnectorMapping(vendorConnectorMappingV2025: VendorConnectorMappingV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VendorConnectorMappingV2025>>;
|
|
89976
|
-
/**
|
|
89977
|
-
* Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
|
|
89978
|
-
* @summary Delete vendor connector mapping
|
|
89979
|
-
* @param {VendorConnectorMappingV2025} vendorConnectorMappingV2025
|
|
89980
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89981
|
-
* @throws {RequiredError}
|
|
89982
|
-
*/
|
|
89983
|
-
deleteVendorConnectorMapping(vendorConnectorMappingV2025: VendorConnectorMappingV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteVendorConnectorMapping200ResponseV2025>>;
|
|
89984
|
-
/**
|
|
89985
|
-
* Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
|
|
89986
|
-
* @summary List vendor connector mappings
|
|
89987
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
89988
|
-
* @throws {RequiredError}
|
|
89989
|
-
*/
|
|
89990
|
-
getVendorConnectorMappings(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMappingV2025>>>;
|
|
89991
|
-
};
|
|
89992
|
-
/**
|
|
89993
|
-
* VendorConnectorMappingsV2025Api - factory interface
|
|
89994
|
-
* @export
|
|
89995
|
-
*/
|
|
89996
|
-
export declare const VendorConnectorMappingsV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
89997
|
-
/**
|
|
89998
|
-
* Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
|
|
89999
|
-
* @summary Create vendor connector mapping
|
|
90000
|
-
* @param {VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
90001
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90002
|
-
* @throws {RequiredError}
|
|
90003
|
-
*/
|
|
90004
|
-
createVendorConnectorMapping(requestParameters: VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<VendorConnectorMappingV2025>;
|
|
90005
|
-
/**
|
|
90006
|
-
* Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
|
|
90007
|
-
* @summary Delete vendor connector mapping
|
|
90008
|
-
* @param {VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
90009
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90010
|
-
* @throws {RequiredError}
|
|
90011
|
-
*/
|
|
90012
|
-
deleteVendorConnectorMapping(requestParameters: VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<DeleteVendorConnectorMapping200ResponseV2025>;
|
|
90013
|
-
/**
|
|
90014
|
-
* Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
|
|
90015
|
-
* @summary List vendor connector mappings
|
|
90016
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90017
|
-
* @throws {RequiredError}
|
|
90018
|
-
*/
|
|
90019
|
-
getVendorConnectorMappings(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<VendorConnectorMappingV2025>>;
|
|
90020
|
-
};
|
|
90021
|
-
/**
|
|
90022
|
-
* Request parameters for createVendorConnectorMapping operation in VendorConnectorMappingsV2025Api.
|
|
90023
|
-
* @export
|
|
90024
|
-
* @interface VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest
|
|
90025
|
-
*/
|
|
90026
|
-
export interface VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest {
|
|
90027
|
-
/**
|
|
90028
|
-
*
|
|
90029
|
-
* @type {VendorConnectorMappingV2025}
|
|
90030
|
-
* @memberof VendorConnectorMappingsV2025ApiCreateVendorConnectorMapping
|
|
90031
|
-
*/
|
|
90032
|
-
readonly vendorConnectorMappingV2025: VendorConnectorMappingV2025;
|
|
90033
|
-
}
|
|
90034
|
-
/**
|
|
90035
|
-
* Request parameters for deleteVendorConnectorMapping operation in VendorConnectorMappingsV2025Api.
|
|
90036
|
-
* @export
|
|
90037
|
-
* @interface VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest
|
|
90038
|
-
*/
|
|
90039
|
-
export interface VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest {
|
|
90040
|
-
/**
|
|
90041
|
-
*
|
|
90042
|
-
* @type {VendorConnectorMappingV2025}
|
|
90043
|
-
* @memberof VendorConnectorMappingsV2025ApiDeleteVendorConnectorMapping
|
|
90044
|
-
*/
|
|
90045
|
-
readonly vendorConnectorMappingV2025: VendorConnectorMappingV2025;
|
|
90046
|
-
}
|
|
90047
|
-
/**
|
|
90048
|
-
* VendorConnectorMappingsV2025Api - object-oriented interface
|
|
90049
|
-
* @export
|
|
90050
|
-
* @class VendorConnectorMappingsV2025Api
|
|
90051
|
-
* @extends {BaseAPI}
|
|
90052
|
-
*/
|
|
90053
|
-
export declare class VendorConnectorMappingsV2025Api extends BaseAPI {
|
|
90054
|
-
/**
|
|
90055
|
-
* Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
|
|
90056
|
-
* @summary Create vendor connector mapping
|
|
90057
|
-
* @param {VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
90058
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90059
|
-
* @throws {RequiredError}
|
|
90060
|
-
* @memberof VendorConnectorMappingsV2025Api
|
|
90061
|
-
*/
|
|
90062
|
-
createVendorConnectorMapping(requestParameters: VendorConnectorMappingsV2025ApiCreateVendorConnectorMappingRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMappingV2025, any>>;
|
|
90063
|
-
/**
|
|
90064
|
-
* Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
|
|
90065
|
-
* @summary Delete vendor connector mapping
|
|
90066
|
-
* @param {VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
90067
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90068
|
-
* @throws {RequiredError}
|
|
90069
|
-
* @memberof VendorConnectorMappingsV2025Api
|
|
90070
|
-
*/
|
|
90071
|
-
deleteVendorConnectorMapping(requestParameters: VendorConnectorMappingsV2025ApiDeleteVendorConnectorMappingRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteVendorConnectorMapping200ResponseV2025, any>>;
|
|
90072
|
-
/**
|
|
90073
|
-
* Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
|
|
90074
|
-
* @summary List vendor connector mappings
|
|
90075
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
90076
|
-
* @throws {RequiredError}
|
|
90077
|
-
* @memberof VendorConnectorMappingsV2025Api
|
|
90078
|
-
*/
|
|
90079
|
-
getVendorConnectorMappings(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMappingV2025[], any>>;
|
|
90080
|
-
}
|
|
90081
91312
|
/**
|
|
90082
91313
|
* WorkItemsV2025Api - axios parameter creator
|
|
90083
91314
|
* @export
|
|
@@ -91492,7 +92723,7 @@ export declare const WorkflowsV2025ApiAxiosParamCreator: (configuration?: Config
|
|
|
91492
92723
|
*/
|
|
91493
92724
|
testExternalExecuteWorkflow: (id: string, testExternalExecuteWorkflowRequestV2025?: TestExternalExecuteWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
91494
92725
|
/**
|
|
91495
|
-
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/
|
|
92726
|
+
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
|
|
91496
92727
|
* @summary Test workflow by id
|
|
91497
92728
|
* @param {string} id Id of the workflow
|
|
91498
92729
|
* @param {TestWorkflowRequestV2025} testWorkflowRequestV2025
|
|
@@ -91661,7 +92892,7 @@ export declare const WorkflowsV2025ApiFp: (configuration?: Configuration) => {
|
|
|
91661
92892
|
*/
|
|
91662
92893
|
testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequestV2025?: TestExternalExecuteWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestExternalExecuteWorkflow200ResponseV2025>>;
|
|
91663
92894
|
/**
|
|
91664
|
-
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/
|
|
92895
|
+
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
|
|
91665
92896
|
* @summary Test workflow by id
|
|
91666
92897
|
* @param {string} id Id of the workflow
|
|
91667
92898
|
* @param {TestWorkflowRequestV2025} testWorkflowRequestV2025
|
|
@@ -91818,7 +93049,7 @@ export declare const WorkflowsV2025ApiFactory: (configuration?: Configuration, b
|
|
|
91818
93049
|
*/
|
|
91819
93050
|
testExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TestExternalExecuteWorkflow200ResponseV2025>;
|
|
91820
93051
|
/**
|
|
91821
|
-
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/
|
|
93052
|
+
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
|
|
91822
93053
|
* @summary Test workflow by id
|
|
91823
93054
|
* @param {WorkflowsV2025ApiTestWorkflowRequest} requestParameters Request parameters.
|
|
91824
93055
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -92293,7 +93524,7 @@ export declare class WorkflowsV2025Api extends BaseAPI {
|
|
|
92293
93524
|
*/
|
|
92294
93525
|
testExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TestExternalExecuteWorkflow200ResponseV2025, any>>;
|
|
92295
93526
|
/**
|
|
92296
|
-
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/
|
|
93527
|
+
* :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
|
|
92297
93528
|
* @summary Test workflow by id
|
|
92298
93529
|
* @param {WorkflowsV2025ApiTestWorkflowRequest} requestParameters Request parameters.
|
|
92299
93530
|
* @param {*} [axiosOptions] Override http request option.
|