sailpoint-api-client 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/.openapi-generator/FILES +1 -0
- package/beta/README.md +2 -2
- package/beta/api.ts +1675 -614
- package/beta/common.ts +2 -1
- package/beta/package.json +1 -1
- package/cc/.openapi-generator/FILES +1 -0
- package/cc/README.md +2 -2
- package/cc/api.ts +56 -46
- package/cc/common.ts +2 -1
- package/cc/package.json +1 -1
- package/configuration.ts +3 -3
- package/dist/beta/api.d.ts +1213 -499
- package/dist/beta/api.js +1258 -490
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -1
- package/dist/beta/common.js.map +1 -1
- package/dist/cc/api.d.ts +40 -40
- package/dist/cc/api.js +31 -26
- package/dist/cc/api.js.map +1 -1
- package/dist/cc/common.js +2 -1
- package/dist/cc/common.js.map +1 -1
- package/dist/configuration.js +3 -3
- package/dist/configuration.js.map +1 -1
- package/dist/index.spec.d.ts +1 -0
- package/dist/index.spec.js +217 -0
- package/dist/index.spec.js.map +1 -0
- package/dist/paginator.js +2 -2
- package/dist/paginator.js.map +1 -1
- package/dist/v2/common.js +2 -1
- package/dist/v2/common.js.map +1 -1
- package/dist/v3/api.d.ts +2929 -594
- package/dist/v3/api.js +4168 -1698
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -1
- package/dist/v3/common.js.map +1 -1
- package/index.spec.ts +119 -0
- package/package.json +12 -2
- package/paginator.ts +2 -2
- package/readme.md +1 -1
- package/tsconfig.json +2 -1
- package/v2/.openapi-generator/FILES +1 -0
- package/v2/README.md +2 -2
- package/v2/common.ts +2 -1
- package/v2/package.json +1 -1
- package/v3/.openapi-generator/FILES +1 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +5722 -2238
- package/v3/common.ts +2 -1
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -68,6 +68,168 @@ export interface AccessAllOf {
|
|
|
68
68
|
*/
|
|
69
69
|
'description'?: string | null;
|
|
70
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @export
|
|
74
|
+
* @interface AccessProfile
|
|
75
|
+
*/
|
|
76
|
+
export interface AccessProfile {
|
|
77
|
+
/**
|
|
78
|
+
* The ID of the Access Profile
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof AccessProfile
|
|
81
|
+
*/
|
|
82
|
+
'id'?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Name of the Access Profile
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof AccessProfile
|
|
87
|
+
*/
|
|
88
|
+
'name': string;
|
|
89
|
+
/**
|
|
90
|
+
* Information about the Access Profile
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof AccessProfile
|
|
93
|
+
*/
|
|
94
|
+
'description'?: string | null;
|
|
95
|
+
/**
|
|
96
|
+
* Date the Access Profile was created
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof AccessProfile
|
|
99
|
+
*/
|
|
100
|
+
'created'?: string;
|
|
101
|
+
/**
|
|
102
|
+
* Date the Access Profile was last modified.
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof AccessProfile
|
|
105
|
+
*/
|
|
106
|
+
'modified'?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.
|
|
109
|
+
* @type {boolean}
|
|
110
|
+
* @memberof AccessProfile
|
|
111
|
+
*/
|
|
112
|
+
'enabled'?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @type {OwnerReference}
|
|
116
|
+
* @memberof AccessProfile
|
|
117
|
+
*/
|
|
118
|
+
'owner': OwnerReference;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @type {AccessProfileSourceRef}
|
|
122
|
+
* @memberof AccessProfile
|
|
123
|
+
*/
|
|
124
|
+
'source': AccessProfileSourceRef;
|
|
125
|
+
/**
|
|
126
|
+
* A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.
|
|
127
|
+
* @type {Array<EntitlementRef>}
|
|
128
|
+
* @memberof AccessProfile
|
|
129
|
+
*/
|
|
130
|
+
'entitlements'?: Array<EntitlementRef>;
|
|
131
|
+
/**
|
|
132
|
+
* Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.
|
|
133
|
+
* @type {boolean}
|
|
134
|
+
* @memberof AccessProfile
|
|
135
|
+
*/
|
|
136
|
+
'requestable'?: boolean;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @type {Requestability}
|
|
140
|
+
* @memberof AccessProfile
|
|
141
|
+
*/
|
|
142
|
+
'accessRequestConfig'?: Requestability;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {Revocability}
|
|
146
|
+
* @memberof AccessProfile
|
|
147
|
+
*/
|
|
148
|
+
'revocationRequestConfig'?: Revocability;
|
|
149
|
+
/**
|
|
150
|
+
* List of IDs of segments, if any, to which this Access Profile is assigned.
|
|
151
|
+
* @type {Array<string>}
|
|
152
|
+
* @memberof AccessProfile
|
|
153
|
+
*/
|
|
154
|
+
'segments'?: Array<string> | null;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {ProvisioningCriteriaLevel1}
|
|
158
|
+
* @memberof AccessProfile
|
|
159
|
+
*/
|
|
160
|
+
'provisioningCriteria'?: ProvisioningCriteriaLevel1 | null;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @export
|
|
165
|
+
* @interface AccessProfileApprovalScheme
|
|
166
|
+
*/
|
|
167
|
+
export interface AccessProfileApprovalScheme {
|
|
168
|
+
/**
|
|
169
|
+
* Describes the individual or group that is responsible for an approval step. Values are as follows. **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
|
|
170
|
+
* @type {string}
|
|
171
|
+
* @memberof AccessProfileApprovalScheme
|
|
172
|
+
*/
|
|
173
|
+
'approverType'?: AccessProfileApprovalSchemeApproverTypeEnum;
|
|
174
|
+
/**
|
|
175
|
+
* Id of the specific approver, used only when approverType is GOVERNANCE_GROUP
|
|
176
|
+
* @type {string}
|
|
177
|
+
* @memberof AccessProfileApprovalScheme
|
|
178
|
+
*/
|
|
179
|
+
'approverId'?: string | null;
|
|
180
|
+
}
|
|
181
|
+
export declare const AccessProfileApprovalSchemeApproverTypeEnum: {
|
|
182
|
+
readonly AppOwner: "APP_OWNER";
|
|
183
|
+
readonly Owner: "OWNER";
|
|
184
|
+
readonly SourceOwner: "SOURCE_OWNER";
|
|
185
|
+
readonly Manager: "MANAGER";
|
|
186
|
+
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
187
|
+
};
|
|
188
|
+
export declare type AccessProfileApprovalSchemeApproverTypeEnum = typeof AccessProfileApprovalSchemeApproverTypeEnum[keyof typeof AccessProfileApprovalSchemeApproverTypeEnum];
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @export
|
|
192
|
+
* @interface AccessProfileBulkDeleteRequest
|
|
193
|
+
*/
|
|
194
|
+
export interface AccessProfileBulkDeleteRequest {
|
|
195
|
+
/**
|
|
196
|
+
* List of IDs of Access Profiles to be deleted.
|
|
197
|
+
* @type {Array<string>}
|
|
198
|
+
* @memberof AccessProfileBulkDeleteRequest
|
|
199
|
+
*/
|
|
200
|
+
'accessProfileIds'?: Array<string>;
|
|
201
|
+
/**
|
|
202
|
+
* If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.
|
|
203
|
+
* @type {boolean}
|
|
204
|
+
* @memberof AccessProfileBulkDeleteRequest
|
|
205
|
+
*/
|
|
206
|
+
'bestEffortOnly'?: boolean;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
* @export
|
|
211
|
+
* @interface AccessProfileBulkDeleteResponse
|
|
212
|
+
*/
|
|
213
|
+
export interface AccessProfileBulkDeleteResponse {
|
|
214
|
+
/**
|
|
215
|
+
* ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status.
|
|
216
|
+
* @type {string}
|
|
217
|
+
* @memberof AccessProfileBulkDeleteResponse
|
|
218
|
+
*/
|
|
219
|
+
'taskId'?: string;
|
|
220
|
+
/**
|
|
221
|
+
* List of IDs of Access Profiles which are pending deletion.
|
|
222
|
+
* @type {Array<string>}
|
|
223
|
+
* @memberof AccessProfileBulkDeleteResponse
|
|
224
|
+
*/
|
|
225
|
+
'pending'?: Array<string>;
|
|
226
|
+
/**
|
|
227
|
+
* List of usages of Access Profiles targeted for deletion.
|
|
228
|
+
* @type {Array<AccessProfileUsage>}
|
|
229
|
+
* @memberof AccessProfileBulkDeleteResponse
|
|
230
|
+
*/
|
|
231
|
+
'inUse'?: Array<AccessProfileUsage>;
|
|
232
|
+
}
|
|
71
233
|
/**
|
|
72
234
|
* This is more of a complete representation of an access profile.
|
|
73
235
|
* @export
|
|
@@ -263,6 +425,35 @@ export interface AccessProfileEntitlement {
|
|
|
263
425
|
*/
|
|
264
426
|
'standalone'?: boolean;
|
|
265
427
|
}
|
|
428
|
+
/**
|
|
429
|
+
*
|
|
430
|
+
* @export
|
|
431
|
+
* @interface AccessProfileRef
|
|
432
|
+
*/
|
|
433
|
+
export interface AccessProfileRef {
|
|
434
|
+
/**
|
|
435
|
+
* ID of the Access Profile
|
|
436
|
+
* @type {string}
|
|
437
|
+
* @memberof AccessProfileRef
|
|
438
|
+
*/
|
|
439
|
+
'id'?: string;
|
|
440
|
+
/**
|
|
441
|
+
* Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result.
|
|
442
|
+
* @type {string}
|
|
443
|
+
* @memberof AccessProfileRef
|
|
444
|
+
*/
|
|
445
|
+
'type'?: AccessProfileRefTypeEnum;
|
|
446
|
+
/**
|
|
447
|
+
* Human-readable display name of the Access Profile. This field is ignored on input.
|
|
448
|
+
* @type {string}
|
|
449
|
+
* @memberof AccessProfileRef
|
|
450
|
+
*/
|
|
451
|
+
'name'?: string;
|
|
452
|
+
}
|
|
453
|
+
export declare const AccessProfileRefTypeEnum: {
|
|
454
|
+
readonly AccessProfile: "ACCESS_PROFILE";
|
|
455
|
+
};
|
|
456
|
+
export declare type AccessProfileRefTypeEnum = typeof AccessProfileRefTypeEnum[keyof typeof AccessProfileRefTypeEnum];
|
|
266
457
|
/**
|
|
267
458
|
* Role
|
|
268
459
|
* @export
|
|
@@ -318,6 +509,35 @@ export interface AccessProfileRole {
|
|
|
318
509
|
*/
|
|
319
510
|
'revocable'?: boolean;
|
|
320
511
|
}
|
|
512
|
+
/**
|
|
513
|
+
*
|
|
514
|
+
* @export
|
|
515
|
+
* @interface AccessProfileSourceRef
|
|
516
|
+
*/
|
|
517
|
+
export interface AccessProfileSourceRef {
|
|
518
|
+
/**
|
|
519
|
+
* The ID of the Source with with which the Access Profile is associated
|
|
520
|
+
* @type {string}
|
|
521
|
+
* @memberof AccessProfileSourceRef
|
|
522
|
+
*/
|
|
523
|
+
'id'?: string;
|
|
524
|
+
/**
|
|
525
|
+
* The type of the Source, will always be SOURCE
|
|
526
|
+
* @type {string}
|
|
527
|
+
* @memberof AccessProfileSourceRef
|
|
528
|
+
*/
|
|
529
|
+
'type'?: AccessProfileSourceRefTypeEnum;
|
|
530
|
+
/**
|
|
531
|
+
* The display name of the associated Source
|
|
532
|
+
* @type {string}
|
|
533
|
+
* @memberof AccessProfileSourceRef
|
|
534
|
+
*/
|
|
535
|
+
'name'?: string;
|
|
536
|
+
}
|
|
537
|
+
export declare const AccessProfileSourceRefTypeEnum: {
|
|
538
|
+
readonly Source: "SOURCE";
|
|
539
|
+
};
|
|
540
|
+
export declare type AccessProfileSourceRefTypeEnum = typeof AccessProfileSourceRefTypeEnum[keyof typeof AccessProfileSourceRefTypeEnum];
|
|
321
541
|
/**
|
|
322
542
|
* This is a summary representation of an access profile.
|
|
323
543
|
* @export
|
|
@@ -398,6 +618,25 @@ export interface AccessProfileSummaryAllOf {
|
|
|
398
618
|
*/
|
|
399
619
|
'revocable'?: boolean;
|
|
400
620
|
}
|
|
621
|
+
/**
|
|
622
|
+
*
|
|
623
|
+
* @export
|
|
624
|
+
* @interface AccessProfileUsage
|
|
625
|
+
*/
|
|
626
|
+
export interface AccessProfileUsage {
|
|
627
|
+
/**
|
|
628
|
+
* ID of the Access Profile that is in use
|
|
629
|
+
* @type {string}
|
|
630
|
+
* @memberof AccessProfileUsage
|
|
631
|
+
*/
|
|
632
|
+
'accessProfileId'?: string;
|
|
633
|
+
/**
|
|
634
|
+
* List of references to objects which are using the indicated Access Profile
|
|
635
|
+
* @type {Array<BaseReferenceDto>}
|
|
636
|
+
* @memberof AccessProfileUsage
|
|
637
|
+
*/
|
|
638
|
+
'usedBy'?: Array<BaseReferenceDto>;
|
|
639
|
+
}
|
|
401
640
|
/**
|
|
402
641
|
*
|
|
403
642
|
* @export
|
|
@@ -501,7 +740,7 @@ export interface AccessRequestItem {
|
|
|
501
740
|
[key: string]: string;
|
|
502
741
|
};
|
|
503
742
|
/**
|
|
504
|
-
* The date the role or access profile is no longer assigned to the specified identity. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. * Currently it is not supported for entitlements.
|
|
743
|
+
* The date the role or access profile is no longer assigned to the specified identity. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. * Currently it is not supported for entitlements. * If sunset date for role or access profile specified, removeDate cannot be established. This rule doesn\'t apply for entitlements.
|
|
505
744
|
* @type {string}
|
|
506
745
|
* @memberof AccessRequestItem
|
|
507
746
|
*/
|
|
@@ -569,7 +808,7 @@ export declare const AccessRequestPhasesResultEnum: {
|
|
|
569
808
|
};
|
|
570
809
|
export declare type AccessRequestPhasesResultEnum = typeof AccessRequestPhasesResultEnum[keyof typeof AccessRequestPhasesResultEnum];
|
|
571
810
|
/**
|
|
572
|
-
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
811
|
+
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
573
812
|
* @export
|
|
574
813
|
* @enum {string}
|
|
575
814
|
*/
|
|
@@ -2356,7 +2595,7 @@ export interface ApprovalComment {
|
|
|
2356
2595
|
*/
|
|
2357
2596
|
export interface ApprovalForwardHistory {
|
|
2358
2597
|
/**
|
|
2359
|
-
* Display name of approver
|
|
2598
|
+
* Display name of approver from whom the approval was forwarded.
|
|
2360
2599
|
* @type {string}
|
|
2361
2600
|
* @memberof ApprovalForwardHistory
|
|
2362
2601
|
*/
|
|
@@ -2368,17 +2607,29 @@ export interface ApprovalForwardHistory {
|
|
|
2368
2607
|
*/
|
|
2369
2608
|
'newApproverName'?: string;
|
|
2370
2609
|
/**
|
|
2371
|
-
* Comment made
|
|
2610
|
+
* Comment made while forwarding.
|
|
2372
2611
|
* @type {string}
|
|
2373
2612
|
* @memberof ApprovalForwardHistory
|
|
2374
2613
|
*/
|
|
2375
|
-
'comment'?: string;
|
|
2614
|
+
'comment'?: string | null;
|
|
2376
2615
|
/**
|
|
2377
2616
|
* Time at which approval was forwarded.
|
|
2378
2617
|
* @type {string}
|
|
2379
2618
|
* @memberof ApprovalForwardHistory
|
|
2380
2619
|
*/
|
|
2381
2620
|
'modified'?: string;
|
|
2621
|
+
/**
|
|
2622
|
+
* Display name of forwarder who forwarded the approval.
|
|
2623
|
+
* @type {string}
|
|
2624
|
+
* @memberof ApprovalForwardHistory
|
|
2625
|
+
*/
|
|
2626
|
+
'forwarderName'?: string | null;
|
|
2627
|
+
/**
|
|
2628
|
+
*
|
|
2629
|
+
* @type {ReassignmentType}
|
|
2630
|
+
* @memberof ApprovalForwardHistory
|
|
2631
|
+
*/
|
|
2632
|
+
'reassignmentType'?: ReassignmentType;
|
|
2382
2633
|
}
|
|
2383
2634
|
/**
|
|
2384
2635
|
*
|
|
@@ -2520,9 +2771,35 @@ export declare const ApprovalScheme: {
|
|
|
2520
2771
|
readonly Manager: "MANAGER";
|
|
2521
2772
|
readonly RoleOwner: "ROLE_OWNER";
|
|
2522
2773
|
readonly AccessProfileOwner: "ACCESS_PROFILE_OWNER";
|
|
2774
|
+
readonly EntitlementOwner: "ENTITLEMENT_OWNER";
|
|
2523
2775
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2524
2776
|
};
|
|
2525
2777
|
export declare type ApprovalScheme = typeof ApprovalScheme[keyof typeof ApprovalScheme];
|
|
2778
|
+
/**
|
|
2779
|
+
*
|
|
2780
|
+
* @export
|
|
2781
|
+
* @interface ApprovalSchemeForRole
|
|
2782
|
+
*/
|
|
2783
|
+
export interface ApprovalSchemeForRole {
|
|
2784
|
+
/**
|
|
2785
|
+
* 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
|
|
2786
|
+
* @type {string}
|
|
2787
|
+
* @memberof ApprovalSchemeForRole
|
|
2788
|
+
*/
|
|
2789
|
+
'approverType'?: ApprovalSchemeForRoleApproverTypeEnum;
|
|
2790
|
+
/**
|
|
2791
|
+
* Id of the specific approver, used only when approverType is GOVERNANCE_GROUP
|
|
2792
|
+
* @type {string}
|
|
2793
|
+
* @memberof ApprovalSchemeForRole
|
|
2794
|
+
*/
|
|
2795
|
+
'approverId'?: string | null;
|
|
2796
|
+
}
|
|
2797
|
+
export declare const ApprovalSchemeForRoleApproverTypeEnum: {
|
|
2798
|
+
readonly Owner: "OWNER";
|
|
2799
|
+
readonly Manager: "MANAGER";
|
|
2800
|
+
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2801
|
+
};
|
|
2802
|
+
export declare type ApprovalSchemeForRoleApproverTypeEnum = typeof ApprovalSchemeForRoleApproverTypeEnum[keyof typeof ApprovalSchemeForRoleApproverTypeEnum];
|
|
2526
2803
|
/**
|
|
2527
2804
|
* Enum representing the non-employee request approval status
|
|
2528
2805
|
* @export
|
|
@@ -3777,10 +4054,10 @@ export interface CompletedApproval {
|
|
|
3777
4054
|
'requesterComment'?: CommentDto;
|
|
3778
4055
|
/**
|
|
3779
4056
|
*
|
|
3780
|
-
* @type {
|
|
4057
|
+
* @type {CompletedApprovalReviewerComment}
|
|
3781
4058
|
* @memberof CompletedApproval
|
|
3782
4059
|
*/
|
|
3783
|
-
'reviewerComment'?:
|
|
4060
|
+
'reviewerComment'?: CompletedApprovalReviewerComment | null;
|
|
3784
4061
|
/**
|
|
3785
4062
|
* The history of the previous reviewers comments.
|
|
3786
4063
|
* @type {Array<CommentDto>}
|
|
@@ -3810,7 +4087,7 @@ export interface CompletedApproval {
|
|
|
3810
4087
|
* @type {string}
|
|
3811
4088
|
* @memberof CompletedApproval
|
|
3812
4089
|
*/
|
|
3813
|
-
'removeDate'?: string;
|
|
4090
|
+
'removeDate'?: string | null;
|
|
3814
4091
|
/**
|
|
3815
4092
|
* If true, then the request was to change the remove date or sunset date.
|
|
3816
4093
|
* @type {boolean}
|
|
@@ -3822,7 +4099,7 @@ export interface CompletedApproval {
|
|
|
3822
4099
|
* @type {string}
|
|
3823
4100
|
* @memberof CompletedApproval
|
|
3824
4101
|
*/
|
|
3825
|
-
'currentRemoveDate'?: string;
|
|
4102
|
+
'currentRemoveDate'?: string | null;
|
|
3826
4103
|
/**
|
|
3827
4104
|
*
|
|
3828
4105
|
* @type {SodViolationContextCheckCompleted}
|
|
@@ -3830,6 +4107,31 @@ export interface CompletedApproval {
|
|
|
3830
4107
|
*/
|
|
3831
4108
|
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
3832
4109
|
}
|
|
4110
|
+
/**
|
|
4111
|
+
* The approval\'s reviewer\'s comment.
|
|
4112
|
+
* @export
|
|
4113
|
+
* @interface CompletedApprovalReviewerComment
|
|
4114
|
+
*/
|
|
4115
|
+
export interface CompletedApprovalReviewerComment {
|
|
4116
|
+
/**
|
|
4117
|
+
* Content of the comment
|
|
4118
|
+
* @type {string}
|
|
4119
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4120
|
+
*/
|
|
4121
|
+
'comment'?: string;
|
|
4122
|
+
/**
|
|
4123
|
+
*
|
|
4124
|
+
* @type {CommentDtoAuthor}
|
|
4125
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4126
|
+
*/
|
|
4127
|
+
'author'?: CommentDtoAuthor;
|
|
4128
|
+
/**
|
|
4129
|
+
* Date and time comment was created
|
|
4130
|
+
* @type {string}
|
|
4131
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4132
|
+
*/
|
|
4133
|
+
'created'?: string;
|
|
4134
|
+
}
|
|
3833
4135
|
/**
|
|
3834
4136
|
* Enum represents completed approval object\'s state.
|
|
3835
4137
|
* @export
|
|
@@ -3918,32 +4220,6 @@ export interface Conditional {
|
|
|
3918
4220
|
[key: string]: any;
|
|
3919
4221
|
};
|
|
3920
4222
|
}
|
|
3921
|
-
/**
|
|
3922
|
-
*
|
|
3923
|
-
* @export
|
|
3924
|
-
* @interface CreateAccessRequest401Response
|
|
3925
|
-
*/
|
|
3926
|
-
export interface CreateAccessRequest401Response {
|
|
3927
|
-
/**
|
|
3928
|
-
* A message describing the error
|
|
3929
|
-
* @type {object}
|
|
3930
|
-
* @memberof CreateAccessRequest401Response
|
|
3931
|
-
*/
|
|
3932
|
-
'error'?: object;
|
|
3933
|
-
}
|
|
3934
|
-
/**
|
|
3935
|
-
*
|
|
3936
|
-
* @export
|
|
3937
|
-
* @interface CreateAccessRequest429Response
|
|
3938
|
-
*/
|
|
3939
|
-
export interface CreateAccessRequest429Response {
|
|
3940
|
-
/**
|
|
3941
|
-
* A message describing the error
|
|
3942
|
-
* @type {object}
|
|
3943
|
-
* @memberof CreateAccessRequest429Response
|
|
3944
|
-
*/
|
|
3945
|
-
'message'?: object;
|
|
3946
|
-
}
|
|
3947
4223
|
/**
|
|
3948
4224
|
*
|
|
3949
4225
|
* @export
|
|
@@ -4724,71 +5000,164 @@ export interface EmailNotificationOption {
|
|
|
4724
5000
|
'emailAddressList'?: Array<string>;
|
|
4725
5001
|
}
|
|
4726
5002
|
/**
|
|
4727
|
-
*
|
|
5003
|
+
*
|
|
4728
5004
|
* @export
|
|
4729
|
-
* @interface
|
|
5005
|
+
* @interface Entitlement
|
|
4730
5006
|
*/
|
|
4731
|
-
export interface
|
|
4732
|
-
/**
|
|
4733
|
-
* The unique ID of the referenced object.
|
|
4734
|
-
* @type {string}
|
|
4735
|
-
* @memberof EntitlementDocument
|
|
4736
|
-
*/
|
|
4737
|
-
'id': string;
|
|
5007
|
+
export interface Entitlement {
|
|
4738
5008
|
/**
|
|
4739
|
-
* The
|
|
5009
|
+
* The entitlement id
|
|
4740
5010
|
* @type {string}
|
|
4741
|
-
* @memberof
|
|
4742
|
-
*/
|
|
4743
|
-
'name': string;
|
|
4744
|
-
/**
|
|
4745
|
-
*
|
|
4746
|
-
* @type {DocumentType}
|
|
4747
|
-
* @memberof EntitlementDocument
|
|
5011
|
+
* @memberof Entitlement
|
|
4748
5012
|
*/
|
|
4749
|
-
'
|
|
5013
|
+
'id'?: string;
|
|
4750
5014
|
/**
|
|
4751
|
-
*
|
|
5015
|
+
* The entitlement name
|
|
4752
5016
|
* @type {string}
|
|
4753
|
-
* @memberof
|
|
5017
|
+
* @memberof Entitlement
|
|
4754
5018
|
*/
|
|
4755
|
-
'
|
|
5019
|
+
'name'?: string;
|
|
4756
5020
|
/**
|
|
4757
|
-
* The
|
|
5021
|
+
* The entitlement attribute name
|
|
4758
5022
|
* @type {string}
|
|
4759
|
-
* @memberof
|
|
5023
|
+
* @memberof Entitlement
|
|
4760
5024
|
*/
|
|
4761
5025
|
'attribute'?: string;
|
|
4762
5026
|
/**
|
|
4763
5027
|
* The value of the entitlement
|
|
4764
5028
|
* @type {string}
|
|
4765
|
-
* @memberof
|
|
5029
|
+
* @memberof Entitlement
|
|
4766
5030
|
*/
|
|
4767
5031
|
'value'?: string;
|
|
4768
5032
|
/**
|
|
4769
|
-
*
|
|
5033
|
+
* The object type of the entitlement from the source schema
|
|
4770
5034
|
* @type {string}
|
|
4771
|
-
* @memberof
|
|
5035
|
+
* @memberof Entitlement
|
|
4772
5036
|
*/
|
|
4773
|
-
'
|
|
5037
|
+
'sourceSchemaObjectType'?: string;
|
|
4774
5038
|
/**
|
|
4775
|
-
*
|
|
5039
|
+
* The description of the entitlement
|
|
4776
5040
|
* @type {string}
|
|
4777
|
-
* @memberof
|
|
5041
|
+
* @memberof Entitlement
|
|
4778
5042
|
*/
|
|
4779
|
-
'
|
|
5043
|
+
'description'?: string;
|
|
4780
5044
|
/**
|
|
4781
|
-
*
|
|
4782
|
-
* @type {
|
|
4783
|
-
* @memberof
|
|
5045
|
+
* True if the entitlement is privileged
|
|
5046
|
+
* @type {boolean}
|
|
5047
|
+
* @memberof Entitlement
|
|
4784
5048
|
*/
|
|
4785
|
-
'
|
|
5049
|
+
'privileged'?: boolean;
|
|
4786
5050
|
/**
|
|
4787
|
-
*
|
|
4788
|
-
* @type {
|
|
4789
|
-
* @memberof
|
|
5051
|
+
* True if the entitlement is cloud governed
|
|
5052
|
+
* @type {boolean}
|
|
5053
|
+
* @memberof Entitlement
|
|
4790
5054
|
*/
|
|
4791
|
-
'
|
|
5055
|
+
'cloudGoverned'?: boolean;
|
|
5056
|
+
/**
|
|
5057
|
+
* Time when the entitlement was created
|
|
5058
|
+
* @type {string}
|
|
5059
|
+
* @memberof Entitlement
|
|
5060
|
+
*/
|
|
5061
|
+
'created'?: string;
|
|
5062
|
+
/**
|
|
5063
|
+
* Time when the entitlement was last modified
|
|
5064
|
+
* @type {string}
|
|
5065
|
+
* @memberof Entitlement
|
|
5066
|
+
*/
|
|
5067
|
+
'modified'?: string;
|
|
5068
|
+
/**
|
|
5069
|
+
*
|
|
5070
|
+
* @type {EntitlementSource}
|
|
5071
|
+
* @memberof Entitlement
|
|
5072
|
+
*/
|
|
5073
|
+
'source'?: EntitlementSource;
|
|
5074
|
+
/**
|
|
5075
|
+
* A map of free-form key-value pairs from the source system
|
|
5076
|
+
* @type {{ [key: string]: any; }}
|
|
5077
|
+
* @memberof Entitlement
|
|
5078
|
+
*/
|
|
5079
|
+
'attributes'?: {
|
|
5080
|
+
[key: string]: any;
|
|
5081
|
+
};
|
|
5082
|
+
/**
|
|
5083
|
+
* List of IDs of segments, if any, to which this Entitlement is assigned.
|
|
5084
|
+
* @type {Array<string>}
|
|
5085
|
+
* @memberof Entitlement
|
|
5086
|
+
*/
|
|
5087
|
+
'segments'?: Array<string> | null;
|
|
5088
|
+
/**
|
|
5089
|
+
*
|
|
5090
|
+
* @type {Array<PermissionDto>}
|
|
5091
|
+
* @memberof Entitlement
|
|
5092
|
+
*/
|
|
5093
|
+
'directPermissions'?: Array<PermissionDto>;
|
|
5094
|
+
}
|
|
5095
|
+
/**
|
|
5096
|
+
* Entitlement
|
|
5097
|
+
* @export
|
|
5098
|
+
* @interface EntitlementDocument
|
|
5099
|
+
*/
|
|
5100
|
+
export interface EntitlementDocument {
|
|
5101
|
+
/**
|
|
5102
|
+
* The unique ID of the referenced object.
|
|
5103
|
+
* @type {string}
|
|
5104
|
+
* @memberof EntitlementDocument
|
|
5105
|
+
*/
|
|
5106
|
+
'id': string;
|
|
5107
|
+
/**
|
|
5108
|
+
* The human readable name of the referenced object.
|
|
5109
|
+
* @type {string}
|
|
5110
|
+
* @memberof EntitlementDocument
|
|
5111
|
+
*/
|
|
5112
|
+
'name': string;
|
|
5113
|
+
/**
|
|
5114
|
+
*
|
|
5115
|
+
* @type {DocumentType}
|
|
5116
|
+
* @memberof EntitlementDocument
|
|
5117
|
+
*/
|
|
5118
|
+
'_type': DocumentType;
|
|
5119
|
+
/**
|
|
5120
|
+
* A description of the entitlement
|
|
5121
|
+
* @type {string}
|
|
5122
|
+
* @memberof EntitlementDocument
|
|
5123
|
+
*/
|
|
5124
|
+
'description'?: string;
|
|
5125
|
+
/**
|
|
5126
|
+
* The name of the entitlement attribute
|
|
5127
|
+
* @type {string}
|
|
5128
|
+
* @memberof EntitlementDocument
|
|
5129
|
+
*/
|
|
5130
|
+
'attribute'?: string;
|
|
5131
|
+
/**
|
|
5132
|
+
* The value of the entitlement
|
|
5133
|
+
* @type {string}
|
|
5134
|
+
* @memberof EntitlementDocument
|
|
5135
|
+
*/
|
|
5136
|
+
'value'?: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* A date-time in ISO-8601 format
|
|
5139
|
+
* @type {string}
|
|
5140
|
+
* @memberof EntitlementDocument
|
|
5141
|
+
*/
|
|
5142
|
+
'modified'?: string | null;
|
|
5143
|
+
/**
|
|
5144
|
+
* A date-time in ISO-8601 format
|
|
5145
|
+
* @type {string}
|
|
5146
|
+
* @memberof EntitlementDocument
|
|
5147
|
+
*/
|
|
5148
|
+
'synced'?: string | null;
|
|
5149
|
+
/**
|
|
5150
|
+
* The display name of the entitlement
|
|
5151
|
+
* @type {string}
|
|
5152
|
+
* @memberof EntitlementDocument
|
|
5153
|
+
*/
|
|
5154
|
+
'displayName'?: string;
|
|
5155
|
+
/**
|
|
5156
|
+
*
|
|
5157
|
+
* @type {Reference1}
|
|
5158
|
+
* @memberof EntitlementDocument
|
|
5159
|
+
*/
|
|
5160
|
+
'source'?: Reference1;
|
|
4792
5161
|
/**
|
|
4793
5162
|
*
|
|
4794
5163
|
* @type {boolean}
|
|
@@ -4995,6 +5364,35 @@ export interface EntitlementDtoAllOf {
|
|
|
4995
5364
|
*/
|
|
4996
5365
|
'source'?: BaseReferenceDto;
|
|
4997
5366
|
}
|
|
5367
|
+
/**
|
|
5368
|
+
*
|
|
5369
|
+
* @export
|
|
5370
|
+
* @interface EntitlementRef
|
|
5371
|
+
*/
|
|
5372
|
+
export interface EntitlementRef {
|
|
5373
|
+
/**
|
|
5374
|
+
* The ID of the Entitlement
|
|
5375
|
+
* @type {string}
|
|
5376
|
+
* @memberof EntitlementRef
|
|
5377
|
+
*/
|
|
5378
|
+
'id'?: string;
|
|
5379
|
+
/**
|
|
5380
|
+
* The type of the Entitlement, will always be ENTITLEMENT
|
|
5381
|
+
* @type {string}
|
|
5382
|
+
* @memberof EntitlementRef
|
|
5383
|
+
*/
|
|
5384
|
+
'type'?: EntitlementRefTypeEnum;
|
|
5385
|
+
/**
|
|
5386
|
+
* The display name of the Entitlement
|
|
5387
|
+
* @type {string}
|
|
5388
|
+
* @memberof EntitlementRef
|
|
5389
|
+
*/
|
|
5390
|
+
'name'?: string;
|
|
5391
|
+
}
|
|
5392
|
+
export declare const EntitlementRefTypeEnum: {
|
|
5393
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
5394
|
+
};
|
|
5395
|
+
export declare type EntitlementRefTypeEnum = typeof EntitlementRefTypeEnum[keyof typeof EntitlementRefTypeEnum];
|
|
4998
5396
|
/**
|
|
4999
5397
|
*
|
|
5000
5398
|
* @export
|
|
@@ -5020,12 +5418,37 @@ export interface EntitlementRequestConfig {
|
|
|
5020
5418
|
*/
|
|
5021
5419
|
'deniedCommentsRequired'?: boolean;
|
|
5022
5420
|
/**
|
|
5023
|
-
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"sourceOwner\", \"manager\" and \"workgroup:{id}\". Multiple workgroups (governance groups) can be used.
|
|
5421
|
+
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\". Multiple workgroups (governance groups) can be used.
|
|
5024
5422
|
* @type {string}
|
|
5025
5423
|
* @memberof EntitlementRequestConfig
|
|
5026
5424
|
*/
|
|
5027
5425
|
'grantRequestApprovalSchemes'?: string;
|
|
5028
5426
|
}
|
|
5427
|
+
/**
|
|
5428
|
+
*
|
|
5429
|
+
* @export
|
|
5430
|
+
* @interface EntitlementSource
|
|
5431
|
+
*/
|
|
5432
|
+
export interface EntitlementSource {
|
|
5433
|
+
/**
|
|
5434
|
+
* The source ID
|
|
5435
|
+
* @type {string}
|
|
5436
|
+
* @memberof EntitlementSource
|
|
5437
|
+
*/
|
|
5438
|
+
'id'?: string;
|
|
5439
|
+
/**
|
|
5440
|
+
* The source type, will always be \"SOURCE\"
|
|
5441
|
+
* @type {string}
|
|
5442
|
+
* @memberof EntitlementSource
|
|
5443
|
+
*/
|
|
5444
|
+
'type'?: string;
|
|
5445
|
+
/**
|
|
5446
|
+
* The source name
|
|
5447
|
+
* @type {string}
|
|
5448
|
+
* @memberof EntitlementSource
|
|
5449
|
+
*/
|
|
5450
|
+
'name'?: string;
|
|
5451
|
+
}
|
|
5029
5452
|
/**
|
|
5030
5453
|
* EntitlementReference
|
|
5031
5454
|
* @export
|
|
@@ -7394,6 +7817,32 @@ export interface LifecycleStateAllOf {
|
|
|
7394
7817
|
*/
|
|
7395
7818
|
'accessProfileIds'?: Set<string>;
|
|
7396
7819
|
}
|
|
7820
|
+
/**
|
|
7821
|
+
*
|
|
7822
|
+
* @export
|
|
7823
|
+
* @interface ListAccessProfiles401Response
|
|
7824
|
+
*/
|
|
7825
|
+
export interface ListAccessProfiles401Response {
|
|
7826
|
+
/**
|
|
7827
|
+
* A message describing the error
|
|
7828
|
+
* @type {object}
|
|
7829
|
+
* @memberof ListAccessProfiles401Response
|
|
7830
|
+
*/
|
|
7831
|
+
'error'?: object;
|
|
7832
|
+
}
|
|
7833
|
+
/**
|
|
7834
|
+
*
|
|
7835
|
+
* @export
|
|
7836
|
+
* @interface ListAccessProfiles429Response
|
|
7837
|
+
*/
|
|
7838
|
+
export interface ListAccessProfiles429Response {
|
|
7839
|
+
/**
|
|
7840
|
+
* A message describing the error
|
|
7841
|
+
* @type {object}
|
|
7842
|
+
* @memberof ListAccessProfiles429Response
|
|
7843
|
+
*/
|
|
7844
|
+
'message'?: object;
|
|
7845
|
+
}
|
|
7397
7846
|
/**
|
|
7398
7847
|
* An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
|
|
7399
7848
|
* @export
|
|
@@ -7509,6 +7958,12 @@ export interface ManualWorkItemDetails {
|
|
|
7509
7958
|
* @memberof ManualWorkItemDetails
|
|
7510
7959
|
*/
|
|
7511
7960
|
'status'?: ManualWorkItemState;
|
|
7961
|
+
/**
|
|
7962
|
+
* The history of approval forward action.
|
|
7963
|
+
* @type {Array<ApprovalForwardHistory>}
|
|
7964
|
+
* @memberof ManualWorkItemDetails
|
|
7965
|
+
*/
|
|
7966
|
+
'forwardHistory'?: Array<ApprovalForwardHistory>;
|
|
7512
7967
|
}
|
|
7513
7968
|
/**
|
|
7514
7969
|
* Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion.
|
|
@@ -9231,6 +9686,31 @@ export interface OwnerAllOf {
|
|
|
9231
9686
|
*/
|
|
9232
9687
|
'email'?: string;
|
|
9233
9688
|
}
|
|
9689
|
+
/**
|
|
9690
|
+
* The owner of this object.
|
|
9691
|
+
* @export
|
|
9692
|
+
* @interface OwnerReference
|
|
9693
|
+
*/
|
|
9694
|
+
export interface OwnerReference {
|
|
9695
|
+
/**
|
|
9696
|
+
*
|
|
9697
|
+
* @type {DtoType}
|
|
9698
|
+
* @memberof OwnerReference
|
|
9699
|
+
*/
|
|
9700
|
+
'type'?: DtoType;
|
|
9701
|
+
/**
|
|
9702
|
+
* Identity id
|
|
9703
|
+
* @type {string}
|
|
9704
|
+
* @memberof OwnerReference
|
|
9705
|
+
*/
|
|
9706
|
+
'id'?: string;
|
|
9707
|
+
/**
|
|
9708
|
+
* Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result.
|
|
9709
|
+
* @type {string}
|
|
9710
|
+
* @memberof OwnerReference
|
|
9711
|
+
*/
|
|
9712
|
+
'name'?: string;
|
|
9713
|
+
}
|
|
9234
9714
|
/**
|
|
9235
9715
|
*
|
|
9236
9716
|
* @export
|
|
@@ -9423,6 +9903,37 @@ export interface PasswordInfoQueryDTO {
|
|
|
9423
9903
|
*/
|
|
9424
9904
|
'sourceName'?: string;
|
|
9425
9905
|
}
|
|
9906
|
+
/**
|
|
9907
|
+
*
|
|
9908
|
+
* @export
|
|
9909
|
+
* @interface PasswordOrgConfig
|
|
9910
|
+
*/
|
|
9911
|
+
export interface PasswordOrgConfig {
|
|
9912
|
+
/**
|
|
9913
|
+
* Indicator whether custom password instructions feature is enabled. The default value is false.
|
|
9914
|
+
* @type {boolean}
|
|
9915
|
+
* @memberof PasswordOrgConfig
|
|
9916
|
+
*/
|
|
9917
|
+
'customInstructionsEnabled'?: boolean;
|
|
9918
|
+
/**
|
|
9919
|
+
* Indicator whether \"digit token\" feature is enabled. The default value is false.
|
|
9920
|
+
* @type {boolean}
|
|
9921
|
+
* @memberof PasswordOrgConfig
|
|
9922
|
+
*/
|
|
9923
|
+
'digitTokenEnabled'?: boolean;
|
|
9924
|
+
/**
|
|
9925
|
+
* The duration of \"digit token\" in minutes. The default value is 5.
|
|
9926
|
+
* @type {number}
|
|
9927
|
+
* @memberof PasswordOrgConfig
|
|
9928
|
+
*/
|
|
9929
|
+
'digitTokenDurationMinutes'?: number;
|
|
9930
|
+
/**
|
|
9931
|
+
* The length of \"digit token\". The default value is 6.
|
|
9932
|
+
* @type {number}
|
|
9933
|
+
* @memberof PasswordOrgConfig
|
|
9934
|
+
*/
|
|
9935
|
+
'digitTokenLength'?: number;
|
|
9936
|
+
}
|
|
9426
9937
|
/**
|
|
9427
9938
|
*
|
|
9428
9939
|
* @export
|
|
@@ -9460,6 +9971,37 @@ export declare const PasswordStatusStateEnum: {
|
|
|
9460
9971
|
readonly Failed: "FAILED";
|
|
9461
9972
|
};
|
|
9462
9973
|
export declare type PasswordStatusStateEnum = typeof PasswordStatusStateEnum[keyof typeof PasswordStatusStateEnum];
|
|
9974
|
+
/**
|
|
9975
|
+
*
|
|
9976
|
+
* @export
|
|
9977
|
+
* @interface PasswordSyncGroup
|
|
9978
|
+
*/
|
|
9979
|
+
export interface PasswordSyncGroup {
|
|
9980
|
+
/**
|
|
9981
|
+
* ID of the sync group
|
|
9982
|
+
* @type {string}
|
|
9983
|
+
* @memberof PasswordSyncGroup
|
|
9984
|
+
*/
|
|
9985
|
+
'id'?: string;
|
|
9986
|
+
/**
|
|
9987
|
+
* Name of the sync group
|
|
9988
|
+
* @type {string}
|
|
9989
|
+
* @memberof PasswordSyncGroup
|
|
9990
|
+
*/
|
|
9991
|
+
'name'?: string;
|
|
9992
|
+
/**
|
|
9993
|
+
* ID of the password policy
|
|
9994
|
+
* @type {string}
|
|
9995
|
+
* @memberof PasswordSyncGroup
|
|
9996
|
+
*/
|
|
9997
|
+
'passwordPolicyId'?: string;
|
|
9998
|
+
/**
|
|
9999
|
+
* List of password managed sources IDs
|
|
10000
|
+
* @type {Array<string>}
|
|
10001
|
+
* @memberof PasswordSyncGroup
|
|
10002
|
+
*/
|
|
10003
|
+
'sourceIds'?: Array<string>;
|
|
10004
|
+
}
|
|
9463
10005
|
/**
|
|
9464
10006
|
*
|
|
9465
10007
|
* @export
|
|
@@ -9592,6 +10134,25 @@ export declare const PendingApprovalAction: {
|
|
|
9592
10134
|
readonly Forwarded: "FORWARDED";
|
|
9593
10135
|
};
|
|
9594
10136
|
export declare type PendingApprovalAction = typeof PendingApprovalAction[keyof typeof PendingApprovalAction];
|
|
10137
|
+
/**
|
|
10138
|
+
* 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.
|
|
10139
|
+
* @export
|
|
10140
|
+
* @interface PermissionDto
|
|
10141
|
+
*/
|
|
10142
|
+
export interface PermissionDto {
|
|
10143
|
+
/**
|
|
10144
|
+
* All the rights (e.g. actions) that this permission allows on the target
|
|
10145
|
+
* @type {Array<string>}
|
|
10146
|
+
* @memberof PermissionDto
|
|
10147
|
+
*/
|
|
10148
|
+
'rights'?: Array<string>;
|
|
10149
|
+
/**
|
|
10150
|
+
* The target the permission would grants rights on.
|
|
10151
|
+
* @type {string}
|
|
10152
|
+
* @memberof PermissionDto
|
|
10153
|
+
*/
|
|
10154
|
+
'target'?: string;
|
|
10155
|
+
}
|
|
9595
10156
|
/**
|
|
9596
10157
|
* Provides additional details about the pre-approval trigger for this request.
|
|
9597
10158
|
* @export
|
|
@@ -9683,6 +10244,18 @@ export interface ProvisioningConfig {
|
|
|
9683
10244
|
* @memberof ProvisioningConfig
|
|
9684
10245
|
*/
|
|
9685
10246
|
'planInitializerScript'?: ProvisioningConfigPlanInitializerScript;
|
|
10247
|
+
/**
|
|
10248
|
+
* Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.
|
|
10249
|
+
* @type {boolean}
|
|
10250
|
+
* @memberof ProvisioningConfig
|
|
10251
|
+
*/
|
|
10252
|
+
'noProvisioningRequests'?: boolean;
|
|
10253
|
+
/**
|
|
10254
|
+
* When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.
|
|
10255
|
+
* @type {number}
|
|
10256
|
+
* @memberof ProvisioningConfig
|
|
10257
|
+
*/
|
|
10258
|
+
'provisioningRequestExpiration'?: number;
|
|
9686
10259
|
}
|
|
9687
10260
|
/**
|
|
9688
10261
|
*
|
|
@@ -9692,22 +10265,22 @@ export interface ProvisioningConfig {
|
|
|
9692
10265
|
export interface ProvisioningConfigManagedResourceRefsInner {
|
|
9693
10266
|
/**
|
|
9694
10267
|
* The type of object being referenced
|
|
9695
|
-
* @type {
|
|
10268
|
+
* @type {object}
|
|
9696
10269
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
9697
10270
|
*/
|
|
9698
10271
|
'type'?: ProvisioningConfigManagedResourceRefsInnerTypeEnum;
|
|
9699
10272
|
/**
|
|
9700
10273
|
* ID of the source
|
|
9701
|
-
* @type {
|
|
10274
|
+
* @type {object}
|
|
9702
10275
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
9703
10276
|
*/
|
|
9704
|
-
'id'?:
|
|
10277
|
+
'id'?: object;
|
|
9705
10278
|
/**
|
|
9706
10279
|
* Human-readable display name of the source
|
|
9707
|
-
* @type {
|
|
10280
|
+
* @type {object}
|
|
9708
10281
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
9709
10282
|
*/
|
|
9710
|
-
'name'?:
|
|
10283
|
+
'name'?: object;
|
|
9711
10284
|
}
|
|
9712
10285
|
export declare const ProvisioningConfigManagedResourceRefsInnerTypeEnum: {
|
|
9713
10286
|
readonly Source: "SOURCE";
|
|
@@ -9727,36 +10300,137 @@ export interface ProvisioningConfigPlanInitializerScript {
|
|
|
9727
10300
|
'source'?: string;
|
|
9728
10301
|
}
|
|
9729
10302
|
/**
|
|
9730
|
-
*
|
|
10303
|
+
* Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
9731
10304
|
* @export
|
|
9732
|
-
* @interface
|
|
10305
|
+
* @interface ProvisioningCriteriaLevel1
|
|
9733
10306
|
*/
|
|
9734
|
-
export interface
|
|
10307
|
+
export interface ProvisioningCriteriaLevel1 {
|
|
9735
10308
|
/**
|
|
9736
|
-
*
|
|
9737
|
-
* @type {
|
|
9738
|
-
* @memberof
|
|
10309
|
+
*
|
|
10310
|
+
* @type {ProvisioningCriteriaOperation}
|
|
10311
|
+
* @memberof ProvisioningCriteriaLevel1
|
|
9739
10312
|
*/
|
|
9740
|
-
'
|
|
9741
|
-
}
|
|
9742
|
-
/**
|
|
9743
|
-
*
|
|
9744
|
-
* @export
|
|
9745
|
-
* @interface ProvisioningPolicy
|
|
9746
|
-
*/
|
|
9747
|
-
export interface ProvisioningPolicy {
|
|
10313
|
+
'operation'?: ProvisioningCriteriaOperation;
|
|
9748
10314
|
/**
|
|
9749
|
-
* the
|
|
10315
|
+
* Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
9750
10316
|
* @type {string}
|
|
9751
|
-
* @memberof
|
|
10317
|
+
* @memberof ProvisioningCriteriaLevel1
|
|
9752
10318
|
*/
|
|
9753
|
-
'
|
|
10319
|
+
'attribute'?: string | null;
|
|
9754
10320
|
/**
|
|
9755
|
-
* the
|
|
10321
|
+
* String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
9756
10322
|
* @type {string}
|
|
9757
|
-
* @memberof
|
|
10323
|
+
* @memberof ProvisioningCriteriaLevel1
|
|
9758
10324
|
*/
|
|
9759
|
-
'
|
|
10325
|
+
'value'?: string | null;
|
|
10326
|
+
/**
|
|
10327
|
+
* Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
10328
|
+
* @type {Array<ProvisioningCriteriaLevel2>}
|
|
10329
|
+
* @memberof ProvisioningCriteriaLevel1
|
|
10330
|
+
*/
|
|
10331
|
+
'children'?: Array<ProvisioningCriteriaLevel2> | null;
|
|
10332
|
+
}
|
|
10333
|
+
/**
|
|
10334
|
+
* Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
10335
|
+
* @export
|
|
10336
|
+
* @interface ProvisioningCriteriaLevel2
|
|
10337
|
+
*/
|
|
10338
|
+
export interface ProvisioningCriteriaLevel2 {
|
|
10339
|
+
/**
|
|
10340
|
+
*
|
|
10341
|
+
* @type {ProvisioningCriteriaOperation}
|
|
10342
|
+
* @memberof ProvisioningCriteriaLevel2
|
|
10343
|
+
*/
|
|
10344
|
+
'operation'?: ProvisioningCriteriaOperation;
|
|
10345
|
+
/**
|
|
10346
|
+
* Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
10347
|
+
* @type {string}
|
|
10348
|
+
* @memberof ProvisioningCriteriaLevel2
|
|
10349
|
+
*/
|
|
10350
|
+
'attribute'?: string | null;
|
|
10351
|
+
/**
|
|
10352
|
+
* String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
10353
|
+
* @type {string}
|
|
10354
|
+
* @memberof ProvisioningCriteriaLevel2
|
|
10355
|
+
*/
|
|
10356
|
+
'value'?: string | null;
|
|
10357
|
+
/**
|
|
10358
|
+
* Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
10359
|
+
* @type {Array<ProvisioningCriteriaLevel3>}
|
|
10360
|
+
* @memberof ProvisioningCriteriaLevel2
|
|
10361
|
+
*/
|
|
10362
|
+
'children'?: Array<ProvisioningCriteriaLevel3> | null;
|
|
10363
|
+
}
|
|
10364
|
+
/**
|
|
10365
|
+
* Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
10366
|
+
* @export
|
|
10367
|
+
* @interface ProvisioningCriteriaLevel3
|
|
10368
|
+
*/
|
|
10369
|
+
export interface ProvisioningCriteriaLevel3 {
|
|
10370
|
+
/**
|
|
10371
|
+
*
|
|
10372
|
+
* @type {ProvisioningCriteriaOperation}
|
|
10373
|
+
* @memberof ProvisioningCriteriaLevel3
|
|
10374
|
+
*/
|
|
10375
|
+
'operation'?: ProvisioningCriteriaOperation;
|
|
10376
|
+
/**
|
|
10377
|
+
* Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
10378
|
+
* @type {string}
|
|
10379
|
+
* @memberof ProvisioningCriteriaLevel3
|
|
10380
|
+
*/
|
|
10381
|
+
'attribute'?: string | null;
|
|
10382
|
+
/**
|
|
10383
|
+
* String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
10384
|
+
* @type {string}
|
|
10385
|
+
* @memberof ProvisioningCriteriaLevel3
|
|
10386
|
+
*/
|
|
10387
|
+
'value'?: string;
|
|
10388
|
+
}
|
|
10389
|
+
/**
|
|
10390
|
+
* Supported operations on ProvisioningCriteria
|
|
10391
|
+
* @export
|
|
10392
|
+
* @enum {string}
|
|
10393
|
+
*/
|
|
10394
|
+
export declare const ProvisioningCriteriaOperation: {
|
|
10395
|
+
readonly Equals: "EQUALS";
|
|
10396
|
+
readonly NotEquals: "NOT_EQUALS";
|
|
10397
|
+
readonly Contains: "CONTAINS";
|
|
10398
|
+
readonly Has: "HAS";
|
|
10399
|
+
readonly And: "AND";
|
|
10400
|
+
readonly Or: "OR";
|
|
10401
|
+
};
|
|
10402
|
+
export declare type ProvisioningCriteriaOperation = typeof ProvisioningCriteriaOperation[keyof typeof ProvisioningCriteriaOperation];
|
|
10403
|
+
/**
|
|
10404
|
+
* Provides additional details about provisioning for this request.
|
|
10405
|
+
* @export
|
|
10406
|
+
* @interface ProvisioningDetails
|
|
10407
|
+
*/
|
|
10408
|
+
export interface ProvisioningDetails {
|
|
10409
|
+
/**
|
|
10410
|
+
* Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase.
|
|
10411
|
+
* @type {string}
|
|
10412
|
+
* @memberof ProvisioningDetails
|
|
10413
|
+
*/
|
|
10414
|
+
'orderedSubPhaseReferences'?: string;
|
|
10415
|
+
}
|
|
10416
|
+
/**
|
|
10417
|
+
*
|
|
10418
|
+
* @export
|
|
10419
|
+
* @interface ProvisioningPolicy
|
|
10420
|
+
*/
|
|
10421
|
+
export interface ProvisioningPolicy {
|
|
10422
|
+
/**
|
|
10423
|
+
* the provisioning policy name
|
|
10424
|
+
* @type {string}
|
|
10425
|
+
* @memberof ProvisioningPolicy
|
|
10426
|
+
*/
|
|
10427
|
+
'name': string;
|
|
10428
|
+
/**
|
|
10429
|
+
* the description of the provisioning policy
|
|
10430
|
+
* @type {string}
|
|
10431
|
+
* @memberof ProvisioningPolicy
|
|
10432
|
+
*/
|
|
10433
|
+
'description'?: string;
|
|
9760
10434
|
/**
|
|
9761
10435
|
*
|
|
9762
10436
|
* @type {UsageType}
|
|
@@ -10130,6 +10804,18 @@ export declare const ReassignmentReferenceTypeEnum: {
|
|
|
10130
10804
|
readonly IdentitySummary: "IDENTITY_SUMMARY";
|
|
10131
10805
|
};
|
|
10132
10806
|
export declare type ReassignmentReferenceTypeEnum = typeof ReassignmentReferenceTypeEnum[keyof typeof ReassignmentReferenceTypeEnum];
|
|
10807
|
+
/**
|
|
10808
|
+
* Type of approval reassignment.
|
|
10809
|
+
* @export
|
|
10810
|
+
* @enum {string}
|
|
10811
|
+
*/
|
|
10812
|
+
export declare const ReassignmentType: {
|
|
10813
|
+
readonly ManualReassignment: "MANUAL_REASSIGNMENT";
|
|
10814
|
+
readonly AutomaticReassignment: "AUTOMATIC_REASSIGNMENT";
|
|
10815
|
+
readonly AutoEscalation: "AUTO_ESCALATION";
|
|
10816
|
+
readonly SelfReviewDelegation: "SELF_REVIEW_DELEGATION";
|
|
10817
|
+
};
|
|
10818
|
+
export declare type ReassignmentType = typeof ReassignmentType[keyof typeof ReassignmentType];
|
|
10133
10819
|
/**
|
|
10134
10820
|
*
|
|
10135
10821
|
* @export
|
|
@@ -10379,6 +11065,56 @@ export interface RequestOnBehalfOfConfig {
|
|
|
10379
11065
|
*/
|
|
10380
11066
|
'allowRequestOnBehalfOfEmployeeByManager'?: boolean;
|
|
10381
11067
|
}
|
|
11068
|
+
/**
|
|
11069
|
+
*
|
|
11070
|
+
* @export
|
|
11071
|
+
* @interface Requestability
|
|
11072
|
+
*/
|
|
11073
|
+
export interface Requestability {
|
|
11074
|
+
/**
|
|
11075
|
+
* Whether the requester of the containing object must provide comments justifying the request
|
|
11076
|
+
* @type {boolean}
|
|
11077
|
+
* @memberof Requestability
|
|
11078
|
+
*/
|
|
11079
|
+
'commentsRequired'?: boolean;
|
|
11080
|
+
/**
|
|
11081
|
+
* Whether an approver must provide comments when denying the request
|
|
11082
|
+
* @type {boolean}
|
|
11083
|
+
* @memberof Requestability
|
|
11084
|
+
*/
|
|
11085
|
+
'denialCommentsRequired'?: boolean;
|
|
11086
|
+
/**
|
|
11087
|
+
* List describing the steps in approving the request
|
|
11088
|
+
* @type {Array<AccessProfileApprovalScheme>}
|
|
11089
|
+
* @memberof Requestability
|
|
11090
|
+
*/
|
|
11091
|
+
'approvalSchemes'?: Array<AccessProfileApprovalScheme>;
|
|
11092
|
+
}
|
|
11093
|
+
/**
|
|
11094
|
+
*
|
|
11095
|
+
* @export
|
|
11096
|
+
* @interface RequestabilityForRole
|
|
11097
|
+
*/
|
|
11098
|
+
export interface RequestabilityForRole {
|
|
11099
|
+
/**
|
|
11100
|
+
* Whether the requester of the containing object must provide comments justifying the request
|
|
11101
|
+
* @type {boolean}
|
|
11102
|
+
* @memberof RequestabilityForRole
|
|
11103
|
+
*/
|
|
11104
|
+
'commentsRequired'?: boolean;
|
|
11105
|
+
/**
|
|
11106
|
+
* Whether an approver must provide comments when denying the request
|
|
11107
|
+
* @type {boolean}
|
|
11108
|
+
* @memberof RequestabilityForRole
|
|
11109
|
+
*/
|
|
11110
|
+
'denialCommentsRequired'?: boolean;
|
|
11111
|
+
/**
|
|
11112
|
+
* List describing the steps in approving the request
|
|
11113
|
+
* @type {Array<ApprovalSchemeForRole>}
|
|
11114
|
+
* @memberof RequestabilityForRole
|
|
11115
|
+
*/
|
|
11116
|
+
'approvalSchemes'?: Array<ApprovalSchemeForRole>;
|
|
11117
|
+
}
|
|
10382
11118
|
/**
|
|
10383
11119
|
*
|
|
10384
11120
|
* @export
|
|
@@ -11089,6 +11825,19 @@ export declare const ReviewerTypeEnum: {
|
|
|
11089
11825
|
readonly Identity: "IDENTITY";
|
|
11090
11826
|
};
|
|
11091
11827
|
export declare type ReviewerTypeEnum = typeof ReviewerTypeEnum[keyof typeof ReviewerTypeEnum];
|
|
11828
|
+
/**
|
|
11829
|
+
*
|
|
11830
|
+
* @export
|
|
11831
|
+
* @interface Revocability
|
|
11832
|
+
*/
|
|
11833
|
+
export interface Revocability {
|
|
11834
|
+
/**
|
|
11835
|
+
* List describing the steps in approving the revocation request
|
|
11836
|
+
* @type {Array<AccessProfileApprovalScheme>}
|
|
11837
|
+
* @memberof Revocability
|
|
11838
|
+
*/
|
|
11839
|
+
'approvalSchemes'?: Array<AccessProfileApprovalScheme>;
|
|
11840
|
+
}
|
|
11092
11841
|
/**
|
|
11093
11842
|
*
|
|
11094
11843
|
* @export
|
|
@@ -11122,6 +11871,247 @@ export interface RightPad {
|
|
|
11122
11871
|
[key: string]: any;
|
|
11123
11872
|
};
|
|
11124
11873
|
}
|
|
11874
|
+
/**
|
|
11875
|
+
* A Role
|
|
11876
|
+
* @export
|
|
11877
|
+
* @interface Role
|
|
11878
|
+
*/
|
|
11879
|
+
export interface Role {
|
|
11880
|
+
/**
|
|
11881
|
+
* The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.
|
|
11882
|
+
* @type {string}
|
|
11883
|
+
* @memberof Role
|
|
11884
|
+
*/
|
|
11885
|
+
'id'?: string;
|
|
11886
|
+
/**
|
|
11887
|
+
* The human-readable display name of the Role
|
|
11888
|
+
* @type {string}
|
|
11889
|
+
* @memberof Role
|
|
11890
|
+
*/
|
|
11891
|
+
'name': string;
|
|
11892
|
+
/**
|
|
11893
|
+
* Date the Role was created
|
|
11894
|
+
* @type {string}
|
|
11895
|
+
* @memberof Role
|
|
11896
|
+
*/
|
|
11897
|
+
'created'?: string;
|
|
11898
|
+
/**
|
|
11899
|
+
* Date the Role was last modified.
|
|
11900
|
+
* @type {string}
|
|
11901
|
+
* @memberof Role
|
|
11902
|
+
*/
|
|
11903
|
+
'modified'?: string;
|
|
11904
|
+
/**
|
|
11905
|
+
* A human-readable description of the Role
|
|
11906
|
+
* @type {string}
|
|
11907
|
+
* @memberof Role
|
|
11908
|
+
*/
|
|
11909
|
+
'description'?: string | null;
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @type {OwnerReference}
|
|
11913
|
+
* @memberof Role
|
|
11914
|
+
*/
|
|
11915
|
+
'owner': OwnerReference;
|
|
11916
|
+
/**
|
|
11917
|
+
*
|
|
11918
|
+
* @type {Array<AccessProfileRef>}
|
|
11919
|
+
* @memberof Role
|
|
11920
|
+
*/
|
|
11921
|
+
'accessProfiles'?: Array<AccessProfileRef> | null;
|
|
11922
|
+
/**
|
|
11923
|
+
*
|
|
11924
|
+
* @type {RoleMembershipSelector}
|
|
11925
|
+
* @memberof Role
|
|
11926
|
+
*/
|
|
11927
|
+
'membership'?: RoleMembershipSelector | null;
|
|
11928
|
+
/**
|
|
11929
|
+
* This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.
|
|
11930
|
+
* @type {{ [key: string]: any; }}
|
|
11931
|
+
* @memberof Role
|
|
11932
|
+
*/
|
|
11933
|
+
'legacyMembershipInfo'?: {
|
|
11934
|
+
[key: string]: any;
|
|
11935
|
+
} | null;
|
|
11936
|
+
/**
|
|
11937
|
+
* Whether the Role is enabled or not. This field is false by default.
|
|
11938
|
+
* @type {boolean}
|
|
11939
|
+
* @memberof Role
|
|
11940
|
+
*/
|
|
11941
|
+
'enabled'?: boolean;
|
|
11942
|
+
/**
|
|
11943
|
+
* Whether the Role can be the target of Access Requests. This field is false by default.
|
|
11944
|
+
* @type {boolean}
|
|
11945
|
+
* @memberof Role
|
|
11946
|
+
*/
|
|
11947
|
+
'requestable'?: boolean;
|
|
11948
|
+
/**
|
|
11949
|
+
*
|
|
11950
|
+
* @type {RequestabilityForRole}
|
|
11951
|
+
* @memberof Role
|
|
11952
|
+
*/
|
|
11953
|
+
'accessRequestConfig'?: RequestabilityForRole;
|
|
11954
|
+
/**
|
|
11955
|
+
*
|
|
11956
|
+
* @type {Revocability}
|
|
11957
|
+
* @memberof Role
|
|
11958
|
+
*/
|
|
11959
|
+
'revocationRequestConfig'?: Revocability;
|
|
11960
|
+
/**
|
|
11961
|
+
* List of IDs of segments, if any, to which this Role is assigned.
|
|
11962
|
+
* @type {Array<string>}
|
|
11963
|
+
* @memberof Role
|
|
11964
|
+
*/
|
|
11965
|
+
'segments'?: Array<string> | null;
|
|
11966
|
+
}
|
|
11967
|
+
/**
|
|
11968
|
+
* Type which indicates how a particular Identity obtained a particular Role
|
|
11969
|
+
* @export
|
|
11970
|
+
* @enum {string}
|
|
11971
|
+
*/
|
|
11972
|
+
export declare const RoleAssignmentSourceType: {
|
|
11973
|
+
readonly AccessRequest: "ACCESS_REQUEST";
|
|
11974
|
+
readonly RoleMembership: "ROLE_MEMBERSHIP";
|
|
11975
|
+
};
|
|
11976
|
+
export declare type RoleAssignmentSourceType = typeof RoleAssignmentSourceType[keyof typeof RoleAssignmentSourceType];
|
|
11977
|
+
/**
|
|
11978
|
+
* Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
|
|
11979
|
+
* @export
|
|
11980
|
+
* @interface RoleCriteriaKey
|
|
11981
|
+
*/
|
|
11982
|
+
export interface RoleCriteriaKey {
|
|
11983
|
+
/**
|
|
11984
|
+
*
|
|
11985
|
+
* @type {RoleCriteriaKeyType}
|
|
11986
|
+
* @memberof RoleCriteriaKey
|
|
11987
|
+
*/
|
|
11988
|
+
'type': RoleCriteriaKeyType;
|
|
11989
|
+
/**
|
|
11990
|
+
* The name of the attribute or entitlement to which the associated criteria applies.
|
|
11991
|
+
* @type {string}
|
|
11992
|
+
* @memberof RoleCriteriaKey
|
|
11993
|
+
*/
|
|
11994
|
+
'property': string;
|
|
11995
|
+
/**
|
|
11996
|
+
* ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT
|
|
11997
|
+
* @type {string}
|
|
11998
|
+
* @memberof RoleCriteriaKey
|
|
11999
|
+
*/
|
|
12000
|
+
'sourceId'?: string | null;
|
|
12001
|
+
}
|
|
12002
|
+
/**
|
|
12003
|
+
* Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.
|
|
12004
|
+
* @export
|
|
12005
|
+
* @enum {string}
|
|
12006
|
+
*/
|
|
12007
|
+
export declare const RoleCriteriaKeyType: {
|
|
12008
|
+
readonly Identity: "IDENTITY";
|
|
12009
|
+
readonly Account: "ACCOUNT";
|
|
12010
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
12011
|
+
};
|
|
12012
|
+
export declare type RoleCriteriaKeyType = typeof RoleCriteriaKeyType[keyof typeof RoleCriteriaKeyType];
|
|
12013
|
+
/**
|
|
12014
|
+
* Defines STANDARD type Role membership
|
|
12015
|
+
* @export
|
|
12016
|
+
* @interface RoleCriteriaLevel1
|
|
12017
|
+
*/
|
|
12018
|
+
export interface RoleCriteriaLevel1 {
|
|
12019
|
+
/**
|
|
12020
|
+
*
|
|
12021
|
+
* @type {RoleCriteriaOperation}
|
|
12022
|
+
* @memberof RoleCriteriaLevel1
|
|
12023
|
+
*/
|
|
12024
|
+
'operation'?: RoleCriteriaOperation;
|
|
12025
|
+
/**
|
|
12026
|
+
*
|
|
12027
|
+
* @type {RoleCriteriaKey}
|
|
12028
|
+
* @memberof RoleCriteriaLevel1
|
|
12029
|
+
*/
|
|
12030
|
+
'key'?: RoleCriteriaKey | null;
|
|
12031
|
+
/**
|
|
12032
|
+
* String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
12033
|
+
* @type {string}
|
|
12034
|
+
* @memberof RoleCriteriaLevel1
|
|
12035
|
+
*/
|
|
12036
|
+
'stringValue'?: string | null;
|
|
12037
|
+
/**
|
|
12038
|
+
* Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
|
|
12039
|
+
* @type {Array<RoleCriteriaLevel2>}
|
|
12040
|
+
* @memberof RoleCriteriaLevel1
|
|
12041
|
+
*/
|
|
12042
|
+
'children'?: Array<RoleCriteriaLevel2> | null;
|
|
12043
|
+
}
|
|
12044
|
+
/**
|
|
12045
|
+
* Defines STANDARD type Role membership
|
|
12046
|
+
* @export
|
|
12047
|
+
* @interface RoleCriteriaLevel2
|
|
12048
|
+
*/
|
|
12049
|
+
export interface RoleCriteriaLevel2 {
|
|
12050
|
+
/**
|
|
12051
|
+
*
|
|
12052
|
+
* @type {RoleCriteriaOperation}
|
|
12053
|
+
* @memberof RoleCriteriaLevel2
|
|
12054
|
+
*/
|
|
12055
|
+
'operation'?: RoleCriteriaOperation;
|
|
12056
|
+
/**
|
|
12057
|
+
*
|
|
12058
|
+
* @type {RoleCriteriaKey}
|
|
12059
|
+
* @memberof RoleCriteriaLevel2
|
|
12060
|
+
*/
|
|
12061
|
+
'key'?: RoleCriteriaKey | null;
|
|
12062
|
+
/**
|
|
12063
|
+
* String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
12064
|
+
* @type {string}
|
|
12065
|
+
* @memberof RoleCriteriaLevel2
|
|
12066
|
+
*/
|
|
12067
|
+
'stringValue'?: string | null;
|
|
12068
|
+
/**
|
|
12069
|
+
* Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
|
|
12070
|
+
* @type {Array<RoleCriteriaLevel3>}
|
|
12071
|
+
* @memberof RoleCriteriaLevel2
|
|
12072
|
+
*/
|
|
12073
|
+
'children'?: Array<RoleCriteriaLevel3> | null;
|
|
12074
|
+
}
|
|
12075
|
+
/**
|
|
12076
|
+
* Defines STANDARD type Role membership
|
|
12077
|
+
* @export
|
|
12078
|
+
* @interface RoleCriteriaLevel3
|
|
12079
|
+
*/
|
|
12080
|
+
export interface RoleCriteriaLevel3 {
|
|
12081
|
+
/**
|
|
12082
|
+
*
|
|
12083
|
+
* @type {RoleCriteriaOperation}
|
|
12084
|
+
* @memberof RoleCriteriaLevel3
|
|
12085
|
+
*/
|
|
12086
|
+
'operation'?: RoleCriteriaOperation;
|
|
12087
|
+
/**
|
|
12088
|
+
*
|
|
12089
|
+
* @type {RoleCriteriaKey}
|
|
12090
|
+
* @memberof RoleCriteriaLevel3
|
|
12091
|
+
*/
|
|
12092
|
+
'key'?: RoleCriteriaKey | null;
|
|
12093
|
+
/**
|
|
12094
|
+
* String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
12095
|
+
* @type {string}
|
|
12096
|
+
* @memberof RoleCriteriaLevel3
|
|
12097
|
+
*/
|
|
12098
|
+
'stringValue'?: string;
|
|
12099
|
+
}
|
|
12100
|
+
/**
|
|
12101
|
+
* An operation
|
|
12102
|
+
* @export
|
|
12103
|
+
* @enum {string}
|
|
12104
|
+
*/
|
|
12105
|
+
export declare const RoleCriteriaOperation: {
|
|
12106
|
+
readonly Equals: "EQUALS";
|
|
12107
|
+
readonly NotEquals: "NOT_EQUALS";
|
|
12108
|
+
readonly Contains: "CONTAINS";
|
|
12109
|
+
readonly StartsWith: "STARTS_WITH";
|
|
12110
|
+
readonly EndsWith: "ENDS_WITH";
|
|
12111
|
+
readonly And: "AND";
|
|
12112
|
+
readonly Or: "OR";
|
|
12113
|
+
};
|
|
12114
|
+
export declare type RoleCriteriaOperation = typeof RoleCriteriaOperation[keyof typeof RoleCriteriaOperation];
|
|
11125
12115
|
/**
|
|
11126
12116
|
* Role
|
|
11127
12117
|
* @export
|
|
@@ -11239,35 +12229,138 @@ export interface RoleDocumentAllOf {
|
|
|
11239
12229
|
'tags'?: Array<string>;
|
|
11240
12230
|
}
|
|
11241
12231
|
/**
|
|
11242
|
-
* Role
|
|
12232
|
+
* A subset of the fields of an Identity which is a member of a Role.
|
|
11243
12233
|
* @export
|
|
11244
|
-
* @interface
|
|
12234
|
+
* @interface RoleIdentity
|
|
11245
12235
|
*/
|
|
11246
|
-
export interface
|
|
12236
|
+
export interface RoleIdentity {
|
|
11247
12237
|
/**
|
|
11248
|
-
* The
|
|
12238
|
+
* The ID of the Identity
|
|
11249
12239
|
* @type {string}
|
|
11250
|
-
* @memberof
|
|
12240
|
+
* @memberof RoleIdentity
|
|
11251
12241
|
*/
|
|
11252
12242
|
'id'?: string;
|
|
11253
12243
|
/**
|
|
11254
|
-
* The
|
|
12244
|
+
* The alias / username of the Identity
|
|
11255
12245
|
* @type {string}
|
|
11256
|
-
* @memberof
|
|
12246
|
+
* @memberof RoleIdentity
|
|
11257
12247
|
*/
|
|
11258
|
-
'
|
|
12248
|
+
'aliasName'?: string;
|
|
11259
12249
|
/**
|
|
11260
|
-
*
|
|
12250
|
+
* The human-readable display name of the Identity
|
|
11261
12251
|
* @type {string}
|
|
11262
|
-
* @memberof
|
|
12252
|
+
* @memberof RoleIdentity
|
|
11263
12253
|
*/
|
|
11264
|
-
'
|
|
12254
|
+
'name'?: string;
|
|
11265
12255
|
/**
|
|
11266
|
-
*
|
|
11267
|
-
* @type {
|
|
11268
|
-
* @memberof
|
|
12256
|
+
* Email address of the Identity
|
|
12257
|
+
* @type {string}
|
|
12258
|
+
* @memberof RoleIdentity
|
|
11269
12259
|
*/
|
|
11270
|
-
'
|
|
12260
|
+
'email'?: string;
|
|
12261
|
+
/**
|
|
12262
|
+
*
|
|
12263
|
+
* @type {RoleAssignmentSourceType}
|
|
12264
|
+
* @memberof RoleIdentity
|
|
12265
|
+
*/
|
|
12266
|
+
'roleAssignmentSource'?: RoleAssignmentSourceType;
|
|
12267
|
+
}
|
|
12268
|
+
/**
|
|
12269
|
+
* A reference to an Identity in an IDENTITY_LIST role membership criteria.
|
|
12270
|
+
* @export
|
|
12271
|
+
* @interface RoleMembershipIdentity
|
|
12272
|
+
*/
|
|
12273
|
+
export interface RoleMembershipIdentity {
|
|
12274
|
+
/**
|
|
12275
|
+
*
|
|
12276
|
+
* @type {DtoType}
|
|
12277
|
+
* @memberof RoleMembershipIdentity
|
|
12278
|
+
*/
|
|
12279
|
+
'type'?: DtoType;
|
|
12280
|
+
/**
|
|
12281
|
+
* Identity id
|
|
12282
|
+
* @type {string}
|
|
12283
|
+
* @memberof RoleMembershipIdentity
|
|
12284
|
+
*/
|
|
12285
|
+
'id'?: string;
|
|
12286
|
+
/**
|
|
12287
|
+
* Human-readable display name of the Identity.
|
|
12288
|
+
* @type {string}
|
|
12289
|
+
* @memberof RoleMembershipIdentity
|
|
12290
|
+
*/
|
|
12291
|
+
'name'?: string | null;
|
|
12292
|
+
/**
|
|
12293
|
+
* User name of the Identity
|
|
12294
|
+
* @type {string}
|
|
12295
|
+
* @memberof RoleMembershipIdentity
|
|
12296
|
+
*/
|
|
12297
|
+
'aliasName'?: string | null;
|
|
12298
|
+
}
|
|
12299
|
+
/**
|
|
12300
|
+
* When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.
|
|
12301
|
+
* @export
|
|
12302
|
+
* @interface RoleMembershipSelector
|
|
12303
|
+
*/
|
|
12304
|
+
export interface RoleMembershipSelector {
|
|
12305
|
+
/**
|
|
12306
|
+
*
|
|
12307
|
+
* @type {RoleMembershipSelectorType}
|
|
12308
|
+
* @memberof RoleMembershipSelector
|
|
12309
|
+
*/
|
|
12310
|
+
'type'?: RoleMembershipSelectorType;
|
|
12311
|
+
/**
|
|
12312
|
+
*
|
|
12313
|
+
* @type {RoleCriteriaLevel1}
|
|
12314
|
+
* @memberof RoleMembershipSelector
|
|
12315
|
+
*/
|
|
12316
|
+
'criteria'?: RoleCriteriaLevel1 | null;
|
|
12317
|
+
/**
|
|
12318
|
+
* Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.
|
|
12319
|
+
* @type {Array<RoleMembershipIdentity>}
|
|
12320
|
+
* @memberof RoleMembershipSelector
|
|
12321
|
+
*/
|
|
12322
|
+
'identities'?: Array<RoleMembershipIdentity> | null;
|
|
12323
|
+
}
|
|
12324
|
+
/**
|
|
12325
|
+
* This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed
|
|
12326
|
+
* @export
|
|
12327
|
+
* @enum {string}
|
|
12328
|
+
*/
|
|
12329
|
+
export declare const RoleMembershipSelectorType: {
|
|
12330
|
+
readonly Standard: "STANDARD";
|
|
12331
|
+
readonly IdentityList: "IDENTITY_LIST";
|
|
12332
|
+
};
|
|
12333
|
+
export declare type RoleMembershipSelectorType = typeof RoleMembershipSelectorType[keyof typeof RoleMembershipSelectorType];
|
|
12334
|
+
/**
|
|
12335
|
+
* Role
|
|
12336
|
+
* @export
|
|
12337
|
+
* @interface RoleSummary
|
|
12338
|
+
*/
|
|
12339
|
+
export interface RoleSummary {
|
|
12340
|
+
/**
|
|
12341
|
+
* The unique ID of the referenced object.
|
|
12342
|
+
* @type {string}
|
|
12343
|
+
* @memberof RoleSummary
|
|
12344
|
+
*/
|
|
12345
|
+
'id'?: string;
|
|
12346
|
+
/**
|
|
12347
|
+
* The human readable name of the referenced object.
|
|
12348
|
+
* @type {string}
|
|
12349
|
+
* @memberof RoleSummary
|
|
12350
|
+
*/
|
|
12351
|
+
'name'?: string;
|
|
12352
|
+
/**
|
|
12353
|
+
*
|
|
12354
|
+
* @type {string}
|
|
12355
|
+
* @memberof RoleSummary
|
|
12356
|
+
*/
|
|
12357
|
+
'displayName'?: string;
|
|
12358
|
+
/**
|
|
12359
|
+
*
|
|
12360
|
+
* @type {DtoType}
|
|
12361
|
+
* @memberof RoleSummary
|
|
12362
|
+
*/
|
|
12363
|
+
'type'?: DtoType;
|
|
11271
12364
|
/**
|
|
11272
12365
|
*
|
|
11273
12366
|
* @type {string}
|
|
@@ -12319,17 +13412,17 @@ export interface ServiceDeskIntegrationDto {
|
|
|
12319
13412
|
*/
|
|
12320
13413
|
'type': string;
|
|
12321
13414
|
/**
|
|
12322
|
-
*
|
|
12323
|
-
* @type {
|
|
13415
|
+
* Reference to the identity that is the owner of this Service Desk integration
|
|
13416
|
+
* @type {BaseReferenceDto}
|
|
12324
13417
|
* @memberof ServiceDeskIntegrationDto
|
|
12325
13418
|
*/
|
|
12326
|
-
'ownerRef'?:
|
|
13419
|
+
'ownerRef'?: BaseReferenceDto;
|
|
12327
13420
|
/**
|
|
12328
|
-
*
|
|
12329
|
-
* @type {
|
|
13421
|
+
* Reference to the source cluster for this Service Desk integration
|
|
13422
|
+
* @type {BaseReferenceDto}
|
|
12330
13423
|
* @memberof ServiceDeskIntegrationDto
|
|
12331
13424
|
*/
|
|
12332
|
-
'clusterRef'?:
|
|
13425
|
+
'clusterRef'?: BaseReferenceDto;
|
|
12333
13426
|
/**
|
|
12334
13427
|
* ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
|
|
12335
13428
|
* @type {string}
|
|
@@ -12359,11 +13452,11 @@ export interface ServiceDeskIntegrationDto {
|
|
|
12359
13452
|
[key: string]: any;
|
|
12360
13453
|
};
|
|
12361
13454
|
/**
|
|
12362
|
-
*
|
|
12363
|
-
* @type {
|
|
13455
|
+
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
13456
|
+
* @type {BaseReferenceDto}
|
|
12364
13457
|
* @memberof ServiceDeskIntegrationDto
|
|
12365
13458
|
*/
|
|
12366
|
-
'beforeProvisioningRule'?:
|
|
13459
|
+
'beforeProvisioningRule'?: BaseReferenceDto;
|
|
12367
13460
|
}
|
|
12368
13461
|
/**
|
|
12369
13462
|
* Specification of a Service Desk integration
|
|
@@ -12384,17 +13477,17 @@ export interface ServiceDeskIntegrationDtoAllOf {
|
|
|
12384
13477
|
*/
|
|
12385
13478
|
'type': string;
|
|
12386
13479
|
/**
|
|
12387
|
-
*
|
|
12388
|
-
* @type {
|
|
13480
|
+
* Reference to the identity that is the owner of this Service Desk integration
|
|
13481
|
+
* @type {BaseReferenceDto}
|
|
12389
13482
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
12390
13483
|
*/
|
|
12391
|
-
'ownerRef'?:
|
|
13484
|
+
'ownerRef'?: BaseReferenceDto;
|
|
12392
13485
|
/**
|
|
12393
|
-
*
|
|
12394
|
-
* @type {
|
|
13486
|
+
* Reference to the source cluster for this Service Desk integration
|
|
13487
|
+
* @type {BaseReferenceDto}
|
|
12395
13488
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
12396
13489
|
*/
|
|
12397
|
-
'clusterRef'?:
|
|
13490
|
+
'clusterRef'?: BaseReferenceDto;
|
|
12398
13491
|
/**
|
|
12399
13492
|
* ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
|
|
12400
13493
|
* @type {string}
|
|
@@ -12424,99 +13517,12 @@ export interface ServiceDeskIntegrationDtoAllOf {
|
|
|
12424
13517
|
[key: string]: any;
|
|
12425
13518
|
};
|
|
12426
13519
|
/**
|
|
12427
|
-
*
|
|
12428
|
-
* @type {
|
|
13520
|
+
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
13521
|
+
* @type {BaseReferenceDto}
|
|
12429
13522
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
12430
13523
|
*/
|
|
12431
|
-
'beforeProvisioningRule'?:
|
|
12432
|
-
}
|
|
12433
|
-
/**
|
|
12434
|
-
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
12435
|
-
* @export
|
|
12436
|
-
* @interface ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
12437
|
-
*/
|
|
12438
|
-
export interface ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule {
|
|
12439
|
-
/**
|
|
12440
|
-
* The type of object being referenced
|
|
12441
|
-
* @type {string}
|
|
12442
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
12443
|
-
*/
|
|
12444
|
-
'type'?: ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum;
|
|
12445
|
-
/**
|
|
12446
|
-
* ID of the rule
|
|
12447
|
-
* @type {string}
|
|
12448
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
12449
|
-
*/
|
|
12450
|
-
'id'?: string;
|
|
12451
|
-
/**
|
|
12452
|
-
* Human-readable display name of the rule
|
|
12453
|
-
* @type {string}
|
|
12454
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
12455
|
-
*/
|
|
12456
|
-
'name'?: string;
|
|
12457
|
-
}
|
|
12458
|
-
export declare const ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum: {
|
|
12459
|
-
readonly Rule: "RULE";
|
|
12460
|
-
};
|
|
12461
|
-
export declare type ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum = typeof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum];
|
|
12462
|
-
/**
|
|
12463
|
-
* Reference to the source cluster for this Service Desk integration
|
|
12464
|
-
* @export
|
|
12465
|
-
* @interface ServiceDeskIntegrationDtoAllOfClusterRef
|
|
12466
|
-
*/
|
|
12467
|
-
export interface ServiceDeskIntegrationDtoAllOfClusterRef {
|
|
12468
|
-
/**
|
|
12469
|
-
* The type of object being referenced
|
|
12470
|
-
* @type {string}
|
|
12471
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
12472
|
-
*/
|
|
12473
|
-
'type'?: ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum;
|
|
12474
|
-
/**
|
|
12475
|
-
* ID of the cluster
|
|
12476
|
-
* @type {string}
|
|
12477
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
12478
|
-
*/
|
|
12479
|
-
'id'?: string;
|
|
12480
|
-
/**
|
|
12481
|
-
* Human-readable display name of the cluster
|
|
12482
|
-
* @type {string}
|
|
12483
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
12484
|
-
*/
|
|
12485
|
-
'name'?: string;
|
|
12486
|
-
}
|
|
12487
|
-
export declare const ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum: {
|
|
12488
|
-
readonly Cluster: "CLUSTER";
|
|
12489
|
-
};
|
|
12490
|
-
export declare type ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum = typeof ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum];
|
|
12491
|
-
/**
|
|
12492
|
-
* Reference to the identity that is the owner of this Service Desk integration
|
|
12493
|
-
* @export
|
|
12494
|
-
* @interface ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
12495
|
-
*/
|
|
12496
|
-
export interface ServiceDeskIntegrationDtoAllOfOwnerRef {
|
|
12497
|
-
/**
|
|
12498
|
-
* The type of object being referenced
|
|
12499
|
-
* @type {string}
|
|
12500
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
12501
|
-
*/
|
|
12502
|
-
'type'?: ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum;
|
|
12503
|
-
/**
|
|
12504
|
-
* ID of the identity
|
|
12505
|
-
* @type {string}
|
|
12506
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
12507
|
-
*/
|
|
12508
|
-
'id'?: string;
|
|
12509
|
-
/**
|
|
12510
|
-
* Human-readable display name of the identity
|
|
12511
|
-
* @type {string}
|
|
12512
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
12513
|
-
*/
|
|
12514
|
-
'name'?: string;
|
|
13524
|
+
'beforeProvisioningRule'?: BaseReferenceDto;
|
|
12515
13525
|
}
|
|
12516
|
-
export declare const ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum: {
|
|
12517
|
-
readonly Identity: "IDENTITY";
|
|
12518
|
-
};
|
|
12519
|
-
export declare type ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum = typeof ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum];
|
|
12520
13526
|
/**
|
|
12521
13527
|
*
|
|
12522
13528
|
* @export
|
|
@@ -12803,6 +13809,12 @@ export interface Source {
|
|
|
12803
13809
|
* @memberof Source
|
|
12804
13810
|
*/
|
|
12805
13811
|
'id'?: string;
|
|
13812
|
+
/**
|
|
13813
|
+
* Human-readable name of the source
|
|
13814
|
+
* @type {string}
|
|
13815
|
+
* @memberof Source
|
|
13816
|
+
*/
|
|
13817
|
+
'name': string;
|
|
12806
13818
|
/**
|
|
12807
13819
|
* Human-readable description of the source
|
|
12808
13820
|
* @type {string}
|
|
@@ -12814,7 +13826,7 @@ export interface Source {
|
|
|
12814
13826
|
* @type {SourceOwner}
|
|
12815
13827
|
* @memberof Source
|
|
12816
13828
|
*/
|
|
12817
|
-
'owner'
|
|
13829
|
+
'owner': SourceOwner;
|
|
12818
13830
|
/**
|
|
12819
13831
|
*
|
|
12820
13832
|
* @type {SourceCluster}
|
|
@@ -12880,7 +13892,7 @@ export interface Source {
|
|
|
12880
13892
|
* @type {string}
|
|
12881
13893
|
* @memberof Source
|
|
12882
13894
|
*/
|
|
12883
|
-
'connector'
|
|
13895
|
+
'connector': string;
|
|
12884
13896
|
/**
|
|
12885
13897
|
* The fully qualified name of the Java class that implements the connector interface.
|
|
12886
13898
|
* @type {string}
|
|
@@ -13703,28 +14715,28 @@ export interface UUIDGenerator {
|
|
|
13703
14715
|
/**
|
|
13704
14716
|
*
|
|
13705
14717
|
* @export
|
|
13706
|
-
* @interface
|
|
14718
|
+
* @interface UpdatePasswordDictionaryRequest
|
|
13707
14719
|
*/
|
|
13708
|
-
export interface
|
|
14720
|
+
export interface UpdatePasswordDictionaryRequest {
|
|
13709
14721
|
/**
|
|
13710
14722
|
*
|
|
13711
|
-
* @type {
|
|
13712
|
-
* @memberof
|
|
14723
|
+
* @type {any}
|
|
14724
|
+
* @memberof UpdatePasswordDictionaryRequest
|
|
13713
14725
|
*/
|
|
13714
|
-
'
|
|
14726
|
+
'file'?: any;
|
|
13715
14727
|
}
|
|
13716
14728
|
/**
|
|
13717
14729
|
*
|
|
13718
14730
|
* @export
|
|
13719
|
-
* @interface
|
|
14731
|
+
* @interface UploadNonEmployeeRecordsInBulkRequest
|
|
13720
14732
|
*/
|
|
13721
|
-
export interface
|
|
14733
|
+
export interface UploadNonEmployeeRecordsInBulkRequest {
|
|
13722
14734
|
/**
|
|
13723
14735
|
*
|
|
13724
|
-
* @type {
|
|
13725
|
-
* @memberof
|
|
14736
|
+
* @type {string}
|
|
14737
|
+
* @memberof UploadNonEmployeeRecordsInBulkRequest
|
|
13726
14738
|
*/
|
|
13727
|
-
'
|
|
14739
|
+
'data': string;
|
|
13728
14740
|
}
|
|
13729
14741
|
/**
|
|
13730
14742
|
*
|
|
@@ -13956,530 +14968,949 @@ export interface WorkItemsSummary {
|
|
|
13956
14968
|
'total'?: number;
|
|
13957
14969
|
}
|
|
13958
14970
|
/**
|
|
13959
|
-
*
|
|
14971
|
+
* AccessProfilesApi - axios parameter creator
|
|
13960
14972
|
* @export
|
|
13961
14973
|
*/
|
|
13962
|
-
export declare const
|
|
14974
|
+
export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13963
14975
|
/**
|
|
13964
|
-
* This
|
|
13965
|
-
* @summary
|
|
13966
|
-
* @param {
|
|
13967
|
-
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
14976
|
+
* This API creates an Access Profile. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile\'s Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
14977
|
+
* @summary Create an Access Profile
|
|
14978
|
+
* @param {AccessProfile} accessProfile
|
|
13968
14979
|
* @param {*} [axiosOptions] Override http request option.
|
|
13969
14980
|
* @throws {RequiredError}
|
|
13970
14981
|
*/
|
|
13971
|
-
|
|
14982
|
+
createAccessProfile: (accessProfile: AccessProfile, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13972
14983
|
/**
|
|
13973
|
-
* This
|
|
13974
|
-
* @summary
|
|
13975
|
-
* @param {
|
|
13976
|
-
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
14984
|
+
* This API initiates a bulk deletion of one or more Access Profiles. By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.
|
|
14985
|
+
* @summary Delete Access Profile(s)
|
|
14986
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
13977
14987
|
* @param {*} [axiosOptions] Override http request option.
|
|
13978
14988
|
* @throws {RequiredError}
|
|
13979
14989
|
*/
|
|
13980
|
-
|
|
14990
|
+
deleteAccessProfilesInBulk: (accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13981
14991
|
/**
|
|
13982
|
-
* This
|
|
13983
|
-
* @summary Get
|
|
13984
|
-
* @param {string}
|
|
13985
|
-
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
14992
|
+
* This API returns an Access Profile by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
14993
|
+
* @summary Get an Access Profile
|
|
14994
|
+
* @param {string} id ID of the Access Profile
|
|
13986
14995
|
* @param {*} [axiosOptions] Override http request option.
|
|
13987
14996
|
* @throws {RequiredError}
|
|
13988
14997
|
*/
|
|
13989
|
-
|
|
14998
|
+
getAccessProfile: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
13990
14999
|
/**
|
|
13991
|
-
* This
|
|
13992
|
-
* @summary
|
|
13993
|
-
* @param {string}
|
|
15000
|
+
* This API lists the Entitlements associated with a given Access Profile A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile
|
|
15001
|
+
* @summary List Access Profile\'s Entitlements
|
|
15002
|
+
* @param {string} id ID of the containing Access Profile
|
|
13994
15003
|
* @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.
|
|
13995
15004
|
* @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.
|
|
13996
15005
|
* @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.
|
|
13997
|
-
* @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:
|
|
13998
|
-
* @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: **created, modified**
|
|
15006
|
+
* @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 Entitlement fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
15007
|
+
* @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, attribute, value, created, modified**
|
|
13999
15008
|
* @param {*} [axiosOptions] Override http request option.
|
|
14000
15009
|
* @throws {RequiredError}
|
|
14001
15010
|
*/
|
|
14002
|
-
|
|
15011
|
+
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14003
15012
|
/**
|
|
14004
|
-
* This
|
|
14005
|
-
* @summary
|
|
14006
|
-
* @param {string} [
|
|
14007
|
-
* @param {number} [limit]
|
|
15013
|
+
* This API returns a list of Access Profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15014
|
+
* @summary List Access Profiles
|
|
15015
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
15016
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
14008
15017
|
* @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.
|
|
14009
15018
|
* @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.
|
|
14010
|
-
* @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* **
|
|
14011
|
-
* @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: **created, modified**
|
|
15019
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
15020
|
+
* @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**
|
|
15021
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
15022
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
14012
15023
|
* @param {*} [axiosOptions] Override http request option.
|
|
14013
15024
|
* @throws {RequiredError}
|
|
14014
15025
|
*/
|
|
14015
|
-
|
|
15026
|
+
listAccessProfiles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14016
15027
|
/**
|
|
14017
|
-
* This
|
|
14018
|
-
* @summary
|
|
14019
|
-
* @param {string}
|
|
14020
|
-
* @param {
|
|
15028
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. > Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.
|
|
15029
|
+
* @summary Patch a specified Access Profile
|
|
15030
|
+
* @param {string} id ID of the Access Profile to patch
|
|
15031
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
14021
15032
|
* @param {*} [axiosOptions] Override http request option.
|
|
14022
15033
|
* @throws {RequiredError}
|
|
14023
15034
|
*/
|
|
14024
|
-
|
|
15035
|
+
patchAccessProfile: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14025
15036
|
};
|
|
14026
15037
|
/**
|
|
14027
|
-
*
|
|
15038
|
+
* AccessProfilesApi - functional programming interface
|
|
14028
15039
|
* @export
|
|
14029
15040
|
*/
|
|
14030
|
-
export declare const
|
|
15041
|
+
export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
14031
15042
|
/**
|
|
14032
|
-
* This
|
|
14033
|
-
* @summary
|
|
14034
|
-
* @param {
|
|
14035
|
-
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15043
|
+
* This API creates an Access Profile. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile\'s Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
15044
|
+
* @summary Create an Access Profile
|
|
15045
|
+
* @param {AccessProfile} accessProfile
|
|
14036
15046
|
* @param {*} [axiosOptions] Override http request option.
|
|
14037
15047
|
* @throws {RequiredError}
|
|
14038
15048
|
*/
|
|
14039
|
-
|
|
15049
|
+
createAccessProfile(accessProfile: AccessProfile, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
14040
15050
|
/**
|
|
14041
|
-
* This
|
|
14042
|
-
* @summary
|
|
14043
|
-
* @param {
|
|
14044
|
-
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
15051
|
+
* This API initiates a bulk deletion of one or more Access Profiles. By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.
|
|
15052
|
+
* @summary Delete Access Profile(s)
|
|
15053
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
14045
15054
|
* @param {*} [axiosOptions] Override http request option.
|
|
14046
15055
|
* @throws {RequiredError}
|
|
14047
15056
|
*/
|
|
14048
|
-
|
|
15057
|
+
deleteAccessProfilesInBulk(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileBulkDeleteResponse>>;
|
|
14049
15058
|
/**
|
|
14050
|
-
* This
|
|
14051
|
-
* @summary Get
|
|
14052
|
-
* @param {string}
|
|
14053
|
-
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
15059
|
+
* This API returns an Access Profile by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15060
|
+
* @summary Get an Access Profile
|
|
15061
|
+
* @param {string} id ID of the Access Profile
|
|
14054
15062
|
* @param {*} [axiosOptions] Override http request option.
|
|
14055
15063
|
* @throws {RequiredError}
|
|
14056
15064
|
*/
|
|
14057
|
-
|
|
15065
|
+
getAccessProfile(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
14058
15066
|
/**
|
|
14059
|
-
* This
|
|
14060
|
-
* @summary
|
|
14061
|
-
* @param {string}
|
|
15067
|
+
* This API lists the Entitlements associated with a given Access Profile A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile
|
|
15068
|
+
* @summary List Access Profile\'s Entitlements
|
|
15069
|
+
* @param {string} id ID of the containing Access Profile
|
|
14062
15070
|
* @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.
|
|
14063
15071
|
* @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.
|
|
14064
15072
|
* @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.
|
|
14065
|
-
* @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:
|
|
14066
|
-
* @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: **created, modified**
|
|
15073
|
+
* @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 Entitlement fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
15074
|
+
* @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, attribute, value, created, modified**
|
|
14067
15075
|
* @param {*} [axiosOptions] Override http request option.
|
|
14068
15076
|
* @throws {RequiredError}
|
|
14069
15077
|
*/
|
|
14070
|
-
|
|
15078
|
+
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
14071
15079
|
/**
|
|
14072
|
-
* This
|
|
14073
|
-
* @summary
|
|
14074
|
-
* @param {string} [
|
|
14075
|
-
* @param {number} [limit]
|
|
15080
|
+
* This API returns a list of Access Profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15081
|
+
* @summary List Access Profiles
|
|
15082
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
15083
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
14076
15084
|
* @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.
|
|
14077
15085
|
* @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.
|
|
14078
|
-
* @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* **
|
|
14079
|
-
* @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: **created, modified**
|
|
15086
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
15087
|
+
* @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**
|
|
15088
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
15089
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
14080
15090
|
* @param {*} [axiosOptions] Override http request option.
|
|
14081
15091
|
* @throws {RequiredError}
|
|
14082
15092
|
*/
|
|
14083
|
-
|
|
15093
|
+
listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfile>>>;
|
|
14084
15094
|
/**
|
|
14085
|
-
* This
|
|
14086
|
-
* @summary
|
|
14087
|
-
* @param {string}
|
|
14088
|
-
* @param {
|
|
15095
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. > Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.
|
|
15096
|
+
* @summary Patch a specified Access Profile
|
|
15097
|
+
* @param {string} id ID of the Access Profile to patch
|
|
15098
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
14089
15099
|
* @param {*} [axiosOptions] Override http request option.
|
|
14090
15100
|
* @throws {RequiredError}
|
|
14091
15101
|
*/
|
|
14092
|
-
|
|
15102
|
+
patchAccessProfile(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
14093
15103
|
};
|
|
14094
15104
|
/**
|
|
14095
|
-
*
|
|
15105
|
+
* AccessProfilesApi - factory interface
|
|
14096
15106
|
* @export
|
|
14097
15107
|
*/
|
|
14098
|
-
export declare const
|
|
15108
|
+
export declare const AccessProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14099
15109
|
/**
|
|
14100
|
-
* This
|
|
14101
|
-
* @summary
|
|
14102
|
-
* @param {
|
|
14103
|
-
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15110
|
+
* This API creates an Access Profile. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile\'s Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
15111
|
+
* @summary Create an Access Profile
|
|
15112
|
+
* @param {AccessProfile} accessProfile
|
|
14104
15113
|
* @param {*} [axiosOptions] Override http request option.
|
|
14105
15114
|
* @throws {RequiredError}
|
|
14106
15115
|
*/
|
|
14107
|
-
|
|
15116
|
+
createAccessProfile(accessProfile: AccessProfile, axiosOptions?: any): AxiosPromise<AccessProfile>;
|
|
14108
15117
|
/**
|
|
14109
|
-
* This
|
|
14110
|
-
* @summary
|
|
14111
|
-
* @param {
|
|
14112
|
-
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
15118
|
+
* This API initiates a bulk deletion of one or more Access Profiles. By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.
|
|
15119
|
+
* @summary Delete Access Profile(s)
|
|
15120
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
14113
15121
|
* @param {*} [axiosOptions] Override http request option.
|
|
14114
15122
|
* @throws {RequiredError}
|
|
14115
15123
|
*/
|
|
14116
|
-
|
|
15124
|
+
deleteAccessProfilesInBulk(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: any): AxiosPromise<AccessProfileBulkDeleteResponse>;
|
|
14117
15125
|
/**
|
|
14118
|
-
* This
|
|
14119
|
-
* @summary Get
|
|
14120
|
-
* @param {string}
|
|
14121
|
-
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
15126
|
+
* This API returns an Access Profile by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15127
|
+
* @summary Get an Access Profile
|
|
15128
|
+
* @param {string} id ID of the Access Profile
|
|
14122
15129
|
* @param {*} [axiosOptions] Override http request option.
|
|
14123
15130
|
* @throws {RequiredError}
|
|
14124
15131
|
*/
|
|
14125
|
-
|
|
15132
|
+
getAccessProfile(id: string, axiosOptions?: any): AxiosPromise<AccessProfile>;
|
|
14126
15133
|
/**
|
|
14127
|
-
* This
|
|
14128
|
-
* @summary
|
|
14129
|
-
* @param {string}
|
|
15134
|
+
* This API lists the Entitlements associated with a given Access Profile A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile
|
|
15135
|
+
* @summary List Access Profile\'s Entitlements
|
|
15136
|
+
* @param {string} id ID of the containing Access Profile
|
|
14130
15137
|
* @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.
|
|
14131
15138
|
* @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.
|
|
14132
15139
|
* @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.
|
|
14133
|
-
* @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:
|
|
14134
|
-
* @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: **created, modified**
|
|
15140
|
+
* @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 Entitlement fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
15141
|
+
* @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, attribute, value, created, modified**
|
|
14135
15142
|
* @param {*} [axiosOptions] Override http request option.
|
|
14136
15143
|
* @throws {RequiredError}
|
|
14137
15144
|
*/
|
|
14138
|
-
|
|
15145
|
+
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Entitlement>>;
|
|
14139
15146
|
/**
|
|
14140
|
-
* This
|
|
14141
|
-
* @summary
|
|
14142
|
-
* @param {string} [
|
|
14143
|
-
* @param {number} [limit]
|
|
15147
|
+
* This API returns a list of Access Profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15148
|
+
* @summary List Access Profiles
|
|
15149
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
15150
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
14144
15151
|
* @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.
|
|
14145
15152
|
* @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.
|
|
14146
|
-
* @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* **
|
|
14147
|
-
* @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: **created, modified**
|
|
15153
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
15154
|
+
* @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**
|
|
15155
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
15156
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
14148
15157
|
* @param {*} [axiosOptions] Override http request option.
|
|
14149
15158
|
* @throws {RequiredError}
|
|
14150
15159
|
*/
|
|
14151
|
-
|
|
15160
|
+
listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: any): AxiosPromise<Array<AccessProfile>>;
|
|
14152
15161
|
/**
|
|
14153
|
-
* This
|
|
14154
|
-
* @summary
|
|
14155
|
-
* @param {string}
|
|
14156
|
-
* @param {
|
|
15162
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. > Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.
|
|
15163
|
+
* @summary Patch a specified Access Profile
|
|
15164
|
+
* @param {string} id ID of the Access Profile to patch
|
|
15165
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
14157
15166
|
* @param {*} [axiosOptions] Override http request option.
|
|
14158
15167
|
* @throws {RequiredError}
|
|
14159
15168
|
*/
|
|
14160
|
-
|
|
15169
|
+
patchAccessProfile(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<AccessProfile>;
|
|
14161
15170
|
};
|
|
14162
15171
|
/**
|
|
14163
|
-
* Request parameters for
|
|
15172
|
+
* Request parameters for createAccessProfile operation in AccessProfilesApi.
|
|
14164
15173
|
* @export
|
|
14165
|
-
* @interface
|
|
15174
|
+
* @interface AccessProfilesApiCreateAccessProfileRequest
|
|
14166
15175
|
*/
|
|
14167
|
-
export interface
|
|
14168
|
-
/**
|
|
14169
|
-
* The id of the approval.
|
|
14170
|
-
* @type {string}
|
|
14171
|
-
* @memberof AccessRequestApprovalsApiApproveAccessRequest
|
|
14172
|
-
*/
|
|
14173
|
-
readonly approvalId: string;
|
|
15176
|
+
export interface AccessProfilesApiCreateAccessProfileRequest {
|
|
14174
15177
|
/**
|
|
14175
|
-
*
|
|
14176
|
-
* @type {
|
|
14177
|
-
* @memberof
|
|
15178
|
+
*
|
|
15179
|
+
* @type {AccessProfile}
|
|
15180
|
+
* @memberof AccessProfilesApiCreateAccessProfile
|
|
14178
15181
|
*/
|
|
14179
|
-
readonly
|
|
15182
|
+
readonly accessProfile: AccessProfile;
|
|
14180
15183
|
}
|
|
14181
15184
|
/**
|
|
14182
|
-
* Request parameters for
|
|
15185
|
+
* Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesApi.
|
|
14183
15186
|
* @export
|
|
14184
|
-
* @interface
|
|
15187
|
+
* @interface AccessProfilesApiDeleteAccessProfilesInBulkRequest
|
|
14185
15188
|
*/
|
|
14186
|
-
export interface
|
|
14187
|
-
/**
|
|
14188
|
-
* The id of the approval.
|
|
14189
|
-
* @type {string}
|
|
14190
|
-
* @memberof AccessRequestApprovalsApiForwardAccessRequest
|
|
14191
|
-
*/
|
|
14192
|
-
readonly approvalId: string;
|
|
15189
|
+
export interface AccessProfilesApiDeleteAccessProfilesInBulkRequest {
|
|
14193
15190
|
/**
|
|
14194
|
-
*
|
|
14195
|
-
* @type {
|
|
14196
|
-
* @memberof
|
|
15191
|
+
*
|
|
15192
|
+
* @type {AccessProfileBulkDeleteRequest}
|
|
15193
|
+
* @memberof AccessProfilesApiDeleteAccessProfilesInBulk
|
|
14197
15194
|
*/
|
|
14198
|
-
readonly
|
|
15195
|
+
readonly accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest;
|
|
14199
15196
|
}
|
|
14200
15197
|
/**
|
|
14201
|
-
* Request parameters for
|
|
15198
|
+
* Request parameters for getAccessProfile operation in AccessProfilesApi.
|
|
14202
15199
|
* @export
|
|
14203
|
-
* @interface
|
|
15200
|
+
* @interface AccessProfilesApiGetAccessProfileRequest
|
|
14204
15201
|
*/
|
|
14205
|
-
export interface
|
|
14206
|
-
/**
|
|
14207
|
-
* The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
14208
|
-
* @type {string}
|
|
14209
|
-
* @memberof AccessRequestApprovalsApiGetAccessRequestApprovalSummary
|
|
14210
|
-
*/
|
|
14211
|
-
readonly ownerId?: string;
|
|
15202
|
+
export interface AccessProfilesApiGetAccessProfileRequest {
|
|
14212
15203
|
/**
|
|
14213
|
-
*
|
|
15204
|
+
* ID of the Access Profile
|
|
14214
15205
|
* @type {string}
|
|
14215
|
-
* @memberof
|
|
15206
|
+
* @memberof AccessProfilesApiGetAccessProfile
|
|
14216
15207
|
*/
|
|
14217
|
-
readonly
|
|
15208
|
+
readonly id: string;
|
|
14218
15209
|
}
|
|
14219
15210
|
/**
|
|
14220
|
-
* Request parameters for
|
|
15211
|
+
* Request parameters for getAccessProfileEntitlements operation in AccessProfilesApi.
|
|
14221
15212
|
* @export
|
|
14222
|
-
* @interface
|
|
15213
|
+
* @interface AccessProfilesApiGetAccessProfileEntitlementsRequest
|
|
14223
15214
|
*/
|
|
14224
|
-
export interface
|
|
15215
|
+
export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
14225
15216
|
/**
|
|
14226
|
-
*
|
|
15217
|
+
* ID of the containing Access Profile
|
|
14227
15218
|
* @type {string}
|
|
14228
|
-
* @memberof
|
|
15219
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14229
15220
|
*/
|
|
14230
|
-
readonly
|
|
15221
|
+
readonly id: string;
|
|
14231
15222
|
/**
|
|
14232
15223
|
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
14233
15224
|
* @type {number}
|
|
14234
|
-
* @memberof
|
|
15225
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14235
15226
|
*/
|
|
14236
15227
|
readonly limit?: number;
|
|
14237
15228
|
/**
|
|
14238
15229
|
* 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.
|
|
14239
15230
|
* @type {number}
|
|
14240
|
-
* @memberof
|
|
15231
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14241
15232
|
*/
|
|
14242
15233
|
readonly offset?: number;
|
|
14243
15234
|
/**
|
|
14244
15235
|
* 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.
|
|
14245
15236
|
* @type {boolean}
|
|
14246
|
-
* @memberof
|
|
15237
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14247
15238
|
*/
|
|
14248
15239
|
readonly count?: boolean;
|
|
14249
15240
|
/**
|
|
14250
|
-
* 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:
|
|
15241
|
+
* 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 Entitlement fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
14251
15242
|
* @type {string}
|
|
14252
|
-
* @memberof
|
|
15243
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14253
15244
|
*/
|
|
14254
15245
|
readonly filters?: string;
|
|
14255
15246
|
/**
|
|
14256
|
-
* 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: **created, modified**
|
|
15247
|
+
* 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, attribute, value, created, modified**
|
|
14257
15248
|
* @type {string}
|
|
14258
|
-
* @memberof
|
|
15249
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
14259
15250
|
*/
|
|
14260
15251
|
readonly sorters?: string;
|
|
14261
15252
|
}
|
|
14262
15253
|
/**
|
|
14263
|
-
* Request parameters for
|
|
15254
|
+
* Request parameters for listAccessProfiles operation in AccessProfilesApi.
|
|
14264
15255
|
* @export
|
|
14265
|
-
* @interface
|
|
15256
|
+
* @interface AccessProfilesApiListAccessProfilesRequest
|
|
14266
15257
|
*/
|
|
14267
|
-
export interface
|
|
15258
|
+
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
14268
15259
|
/**
|
|
14269
|
-
* If
|
|
15260
|
+
* If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
14270
15261
|
* @type {string}
|
|
14271
|
-
* @memberof
|
|
15262
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14272
15263
|
*/
|
|
14273
|
-
readonly
|
|
15264
|
+
readonly forSubadmin?: string;
|
|
14274
15265
|
/**
|
|
14275
|
-
*
|
|
15266
|
+
* Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
14276
15267
|
* @type {number}
|
|
14277
|
-
* @memberof
|
|
15268
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14278
15269
|
*/
|
|
14279
15270
|
readonly limit?: number;
|
|
14280
15271
|
/**
|
|
14281
15272
|
* 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.
|
|
14282
15273
|
* @type {number}
|
|
14283
|
-
* @memberof
|
|
15274
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14284
15275
|
*/
|
|
14285
15276
|
readonly offset?: number;
|
|
14286
15277
|
/**
|
|
14287
15278
|
* 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.
|
|
14288
15279
|
* @type {boolean}
|
|
14289
|
-
* @memberof
|
|
15280
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14290
15281
|
*/
|
|
14291
15282
|
readonly count?: boolean;
|
|
14292
15283
|
/**
|
|
14293
|
-
* 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* **
|
|
15284
|
+
* 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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
14294
15285
|
* @type {string}
|
|
14295
|
-
* @memberof
|
|
15286
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14296
15287
|
*/
|
|
14297
15288
|
readonly filters?: string;
|
|
14298
15289
|
/**
|
|
14299
|
-
* 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: **created, modified**
|
|
15290
|
+
* 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**
|
|
14300
15291
|
* @type {string}
|
|
14301
|
-
* @memberof
|
|
15292
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
14302
15293
|
*/
|
|
14303
15294
|
readonly sorters?: string;
|
|
15295
|
+
/**
|
|
15296
|
+
* If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
15297
|
+
* @type {string}
|
|
15298
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
15299
|
+
*/
|
|
15300
|
+
readonly forSegmentIds?: string;
|
|
15301
|
+
/**
|
|
15302
|
+
* Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
15303
|
+
* @type {boolean}
|
|
15304
|
+
* @memberof AccessProfilesApiListAccessProfiles
|
|
15305
|
+
*/
|
|
15306
|
+
readonly includeUnsegmented?: boolean;
|
|
14304
15307
|
}
|
|
14305
15308
|
/**
|
|
14306
|
-
* Request parameters for
|
|
15309
|
+
* Request parameters for patchAccessProfile operation in AccessProfilesApi.
|
|
14307
15310
|
* @export
|
|
14308
|
-
* @interface
|
|
15311
|
+
* @interface AccessProfilesApiPatchAccessProfileRequest
|
|
14309
15312
|
*/
|
|
14310
|
-
export interface
|
|
15313
|
+
export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
14311
15314
|
/**
|
|
14312
|
-
*
|
|
15315
|
+
* ID of the Access Profile to patch
|
|
14313
15316
|
* @type {string}
|
|
14314
|
-
* @memberof
|
|
15317
|
+
* @memberof AccessProfilesApiPatchAccessProfile
|
|
14315
15318
|
*/
|
|
14316
|
-
readonly
|
|
15319
|
+
readonly id: string;
|
|
14317
15320
|
/**
|
|
14318
|
-
*
|
|
14319
|
-
* @type {
|
|
14320
|
-
* @memberof
|
|
15321
|
+
*
|
|
15322
|
+
* @type {Array<JsonPatchOperation>}
|
|
15323
|
+
* @memberof AccessProfilesApiPatchAccessProfile
|
|
14321
15324
|
*/
|
|
14322
|
-
readonly
|
|
15325
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
14323
15326
|
}
|
|
14324
15327
|
/**
|
|
14325
|
-
*
|
|
15328
|
+
* AccessProfilesApi - object-oriented interface
|
|
14326
15329
|
* @export
|
|
14327
|
-
* @class
|
|
15330
|
+
* @class AccessProfilesApi
|
|
14328
15331
|
* @extends {BaseAPI}
|
|
14329
15332
|
*/
|
|
14330
|
-
export declare class
|
|
15333
|
+
export declare class AccessProfilesApi extends BaseAPI {
|
|
14331
15334
|
/**
|
|
14332
|
-
* This
|
|
14333
|
-
* @summary
|
|
14334
|
-
* @param {
|
|
15335
|
+
* This API creates an Access Profile. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile\'s Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
15336
|
+
* @summary Create an Access Profile
|
|
15337
|
+
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
14335
15338
|
* @param {*} [axiosOptions] Override http request option.
|
|
14336
15339
|
* @throws {RequiredError}
|
|
14337
|
-
* @memberof
|
|
15340
|
+
* @memberof AccessProfilesApi
|
|
14338
15341
|
*/
|
|
14339
|
-
|
|
15342
|
+
createAccessProfile(requestParameters: AccessProfilesApiCreateAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
14340
15343
|
/**
|
|
14341
|
-
* This
|
|
14342
|
-
* @summary
|
|
14343
|
-
* @param {
|
|
15344
|
+
* This API initiates a bulk deletion of one or more Access Profiles. By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.
|
|
15345
|
+
* @summary Delete Access Profile(s)
|
|
15346
|
+
* @param {AccessProfilesApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters.
|
|
14344
15347
|
* @param {*} [axiosOptions] Override http request option.
|
|
14345
15348
|
* @throws {RequiredError}
|
|
14346
|
-
* @memberof
|
|
15349
|
+
* @memberof AccessProfilesApi
|
|
14347
15350
|
*/
|
|
14348
|
-
|
|
15351
|
+
deleteAccessProfilesInBulk(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBulkDeleteResponse, any>>;
|
|
14349
15352
|
/**
|
|
14350
|
-
* This
|
|
14351
|
-
* @summary Get
|
|
14352
|
-
* @param {
|
|
15353
|
+
* This API returns an Access Profile by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15354
|
+
* @summary Get an Access Profile
|
|
15355
|
+
* @param {AccessProfilesApiGetAccessProfileRequest} requestParameters Request parameters.
|
|
14353
15356
|
* @param {*} [axiosOptions] Override http request option.
|
|
14354
15357
|
* @throws {RequiredError}
|
|
14355
|
-
* @memberof
|
|
15358
|
+
* @memberof AccessProfilesApi
|
|
14356
15359
|
*/
|
|
14357
|
-
|
|
15360
|
+
getAccessProfile(requestParameters: AccessProfilesApiGetAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
14358
15361
|
/**
|
|
14359
|
-
* This
|
|
14360
|
-
* @summary
|
|
14361
|
-
* @param {
|
|
15362
|
+
* This API lists the Entitlements associated with a given Access Profile A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile
|
|
15363
|
+
* @summary List Access Profile\'s Entitlements
|
|
15364
|
+
* @param {AccessProfilesApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters.
|
|
14362
15365
|
* @param {*} [axiosOptions] Override http request option.
|
|
14363
15366
|
* @throws {RequiredError}
|
|
14364
|
-
* @memberof
|
|
15367
|
+
* @memberof AccessProfilesApi
|
|
14365
15368
|
*/
|
|
14366
|
-
|
|
15369
|
+
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
14367
15370
|
/**
|
|
14368
|
-
* This
|
|
14369
|
-
* @summary
|
|
14370
|
-
* @param {
|
|
15371
|
+
* This API returns a list of Access Profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
15372
|
+
* @summary List Access Profiles
|
|
15373
|
+
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
14371
15374
|
* @param {*} [axiosOptions] Override http request option.
|
|
14372
15375
|
* @throws {RequiredError}
|
|
14373
|
-
* @memberof
|
|
15376
|
+
* @memberof AccessProfilesApi
|
|
14374
15377
|
*/
|
|
14375
|
-
|
|
15378
|
+
listAccessProfiles(requestParameters?: AccessProfilesApiListAccessProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile[], any>>;
|
|
14376
15379
|
/**
|
|
14377
|
-
* This
|
|
14378
|
-
* @summary
|
|
14379
|
-
* @param {
|
|
15380
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. > Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.
|
|
15381
|
+
* @summary Patch a specified Access Profile
|
|
15382
|
+
* @param {AccessProfilesApiPatchAccessProfileRequest} requestParameters Request parameters.
|
|
14380
15383
|
* @param {*} [axiosOptions] Override http request option.
|
|
14381
15384
|
* @throws {RequiredError}
|
|
14382
|
-
* @memberof
|
|
15385
|
+
* @memberof AccessProfilesApi
|
|
14383
15386
|
*/
|
|
14384
|
-
|
|
15387
|
+
patchAccessProfile(requestParameters: AccessProfilesApiPatchAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
14385
15388
|
}
|
|
14386
15389
|
/**
|
|
14387
|
-
*
|
|
15390
|
+
* AccessRequestApprovalsApi - axios parameter creator
|
|
14388
15391
|
* @export
|
|
14389
15392
|
*/
|
|
14390
|
-
export declare const
|
|
15393
|
+
export declare const AccessRequestApprovalsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14391
15394
|
/**
|
|
14392
|
-
* This
|
|
14393
|
-
* @summary
|
|
14394
|
-
* @param {
|
|
15395
|
+
* This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15396
|
+
* @summary Approves an access request approval.
|
|
15397
|
+
* @param {string} approvalId The id of the approval.
|
|
15398
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
14395
15399
|
* @param {*} [axiosOptions] Override http request option.
|
|
14396
15400
|
* @throws {RequiredError}
|
|
14397
15401
|
*/
|
|
14398
|
-
|
|
15402
|
+
approveAccessRequest: (approvalId: string, commentDto?: CommentDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14399
15403
|
/**
|
|
14400
|
-
* This
|
|
14401
|
-
* @summary
|
|
14402
|
-
* @param {
|
|
15404
|
+
* This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15405
|
+
* @summary Forwards an access request approval.
|
|
15406
|
+
* @param {string} approvalId The id of the approval.
|
|
15407
|
+
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
14403
15408
|
* @param {*} [axiosOptions] Override http request option.
|
|
14404
15409
|
* @throws {RequiredError}
|
|
14405
15410
|
*/
|
|
14406
|
-
|
|
15411
|
+
forwardAccessRequest: (approvalId: string, forwardApprovalDto: ForwardApprovalDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14407
15412
|
/**
|
|
14408
|
-
* This endpoint returns the
|
|
14409
|
-
* @summary Get
|
|
15413
|
+
* This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15414
|
+
* @summary Get the number of access-requests-approvals
|
|
15415
|
+
* @param {string} [ownerId] The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15416
|
+
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
14410
15417
|
* @param {*} [axiosOptions] Override http request option.
|
|
14411
15418
|
* @throws {RequiredError}
|
|
14412
15419
|
*/
|
|
14413
|
-
|
|
15420
|
+
getAccessRequestApprovalSummary: (ownerId?: string, fromDate?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14414
15421
|
/**
|
|
14415
|
-
*
|
|
14416
|
-
* @summary Access Request
|
|
14417
|
-
* @param {string} [
|
|
14418
|
-
* @param {
|
|
14419
|
-
* @param {
|
|
14420
|
-
* @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.
|
|
14421
|
-
* @param {
|
|
14422
|
-
* @param {
|
|
14423
|
-
* @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: **accountActivityItemId**: *eq, in*
|
|
14424
|
-
* @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: **created, modified, accountActivityItemId**
|
|
15422
|
+
* This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
|
15423
|
+
* @summary Completed Access Request Approvals List
|
|
15424
|
+
* @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15425
|
+
* @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.
|
|
15426
|
+
* @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.
|
|
15427
|
+
* @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.
|
|
15428
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15429
|
+
* @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: **created, modified**
|
|
14425
15430
|
* @param {*} [axiosOptions] Override http request option.
|
|
14426
15431
|
* @throws {RequiredError}
|
|
14427
15432
|
*/
|
|
14428
|
-
|
|
15433
|
+
listCompletedApprovals: (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14429
15434
|
/**
|
|
14430
|
-
* This endpoint
|
|
14431
|
-
* @summary
|
|
14432
|
-
* @param {
|
|
15435
|
+
* This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15436
|
+
* @summary Pending Access Request Approvals List
|
|
15437
|
+
* @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15438
|
+
* @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.
|
|
15439
|
+
* @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.
|
|
15440
|
+
* @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.
|
|
15441
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15442
|
+
* @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: **created, modified**
|
|
14433
15443
|
* @param {*} [axiosOptions] Override http request option.
|
|
14434
15444
|
* @throws {RequiredError}
|
|
14435
15445
|
*/
|
|
14436
|
-
|
|
15446
|
+
listPendingApprovals: (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15447
|
+
/**
|
|
15448
|
+
* This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
|
15449
|
+
* @summary Rejects an access request approval.
|
|
15450
|
+
* @param {string} approvalId The id of the approval.
|
|
15451
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15452
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15453
|
+
* @throws {RequiredError}
|
|
15454
|
+
*/
|
|
15455
|
+
rejectAccessRequest: (approvalId: string, commentDto?: CommentDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14437
15456
|
};
|
|
14438
15457
|
/**
|
|
14439
|
-
*
|
|
15458
|
+
* AccessRequestApprovalsApi - functional programming interface
|
|
14440
15459
|
* @export
|
|
14441
15460
|
*/
|
|
14442
|
-
export declare const
|
|
15461
|
+
export declare const AccessRequestApprovalsApiFp: (configuration?: Configuration) => {
|
|
14443
15462
|
/**
|
|
14444
|
-
* This
|
|
14445
|
-
* @summary
|
|
14446
|
-
* @param {
|
|
15463
|
+
* This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15464
|
+
* @summary Approves an access request approval.
|
|
15465
|
+
* @param {string} approvalId The id of the approval.
|
|
15466
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
14447
15467
|
* @param {*} [axiosOptions] Override http request option.
|
|
14448
15468
|
* @throws {RequiredError}
|
|
14449
15469
|
*/
|
|
14450
|
-
|
|
15470
|
+
approveAccessRequest(approvalId: string, commentDto?: CommentDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14451
15471
|
/**
|
|
14452
|
-
* This
|
|
14453
|
-
* @summary
|
|
14454
|
-
* @param {
|
|
15472
|
+
* This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15473
|
+
* @summary Forwards an access request approval.
|
|
15474
|
+
* @param {string} approvalId The id of the approval.
|
|
15475
|
+
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
14455
15476
|
* @param {*} [axiosOptions] Override http request option.
|
|
14456
15477
|
* @throws {RequiredError}
|
|
14457
15478
|
*/
|
|
14458
|
-
|
|
15479
|
+
forwardAccessRequest(approvalId: string, forwardApprovalDto: ForwardApprovalDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14459
15480
|
/**
|
|
14460
|
-
* This endpoint returns the
|
|
14461
|
-
* @summary Get
|
|
15481
|
+
* This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15482
|
+
* @summary Get the number of access-requests-approvals
|
|
15483
|
+
* @param {string} [ownerId] The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15484
|
+
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
14462
15485
|
* @param {*} [axiosOptions] Override http request option.
|
|
14463
15486
|
* @throws {RequiredError}
|
|
14464
15487
|
*/
|
|
14465
|
-
|
|
15488
|
+
getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApprovalSummary>>;
|
|
14466
15489
|
/**
|
|
14467
|
-
*
|
|
14468
|
-
* @summary Access Request
|
|
14469
|
-
* @param {string} [
|
|
14470
|
-
* @param {
|
|
14471
|
-
* @param {
|
|
14472
|
-
* @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.
|
|
14473
|
-
* @param {
|
|
14474
|
-
* @param {
|
|
14475
|
-
* @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: **accountActivityItemId**: *eq, in*
|
|
14476
|
-
* @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: **created, modified, accountActivityItemId**
|
|
15490
|
+
* This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
|
15491
|
+
* @summary Completed Access Request Approvals List
|
|
15492
|
+
* @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15493
|
+
* @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.
|
|
15494
|
+
* @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.
|
|
15495
|
+
* @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.
|
|
15496
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15497
|
+
* @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: **created, modified**
|
|
14477
15498
|
* @param {*} [axiosOptions] Override http request option.
|
|
14478
15499
|
* @throws {RequiredError}
|
|
14479
15500
|
*/
|
|
14480
|
-
|
|
15501
|
+
listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CompletedApproval>>>;
|
|
14481
15502
|
/**
|
|
14482
|
-
* This endpoint
|
|
15503
|
+
* This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15504
|
+
* @summary Pending Access Request Approvals List
|
|
15505
|
+
* @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15506
|
+
* @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.
|
|
15507
|
+
* @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.
|
|
15508
|
+
* @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.
|
|
15509
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15510
|
+
* @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: **created, modified**
|
|
15511
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15512
|
+
* @throws {RequiredError}
|
|
15513
|
+
*/
|
|
15514
|
+
listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PendingApproval>>>;
|
|
15515
|
+
/**
|
|
15516
|
+
* This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
|
15517
|
+
* @summary Rejects an access request approval.
|
|
15518
|
+
* @param {string} approvalId The id of the approval.
|
|
15519
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15520
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15521
|
+
* @throws {RequiredError}
|
|
15522
|
+
*/
|
|
15523
|
+
rejectAccessRequest(approvalId: string, commentDto?: CommentDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15524
|
+
};
|
|
15525
|
+
/**
|
|
15526
|
+
* AccessRequestApprovalsApi - factory interface
|
|
15527
|
+
* @export
|
|
15528
|
+
*/
|
|
15529
|
+
export declare const AccessRequestApprovalsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15530
|
+
/**
|
|
15531
|
+
* This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15532
|
+
* @summary Approves an access request approval.
|
|
15533
|
+
* @param {string} approvalId The id of the approval.
|
|
15534
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15535
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15536
|
+
* @throws {RequiredError}
|
|
15537
|
+
*/
|
|
15538
|
+
approveAccessRequest(approvalId: string, commentDto?: CommentDto, axiosOptions?: any): AxiosPromise<object>;
|
|
15539
|
+
/**
|
|
15540
|
+
* This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15541
|
+
* @summary Forwards an access request approval.
|
|
15542
|
+
* @param {string} approvalId The id of the approval.
|
|
15543
|
+
* @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval.
|
|
15544
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15545
|
+
* @throws {RequiredError}
|
|
15546
|
+
*/
|
|
15547
|
+
forwardAccessRequest(approvalId: string, forwardApprovalDto: ForwardApprovalDto, axiosOptions?: any): AxiosPromise<object>;
|
|
15548
|
+
/**
|
|
15549
|
+
* This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15550
|
+
* @summary Get the number of access-requests-approvals
|
|
15551
|
+
* @param {string} [ownerId] The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15552
|
+
* @param {string} [fromDate] From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
15553
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15554
|
+
* @throws {RequiredError}
|
|
15555
|
+
*/
|
|
15556
|
+
getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: any): AxiosPromise<ApprovalSummary>;
|
|
15557
|
+
/**
|
|
15558
|
+
* This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
|
15559
|
+
* @summary Completed Access Request Approvals List
|
|
15560
|
+
* @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15561
|
+
* @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.
|
|
15562
|
+
* @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.
|
|
15563
|
+
* @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.
|
|
15564
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15565
|
+
* @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: **created, modified**
|
|
15566
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15567
|
+
* @throws {RequiredError}
|
|
15568
|
+
*/
|
|
15569
|
+
listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<CompletedApproval>>;
|
|
15570
|
+
/**
|
|
15571
|
+
* This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15572
|
+
* @summary Pending Access Request Approvals List
|
|
15573
|
+
* @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15574
|
+
* @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.
|
|
15575
|
+
* @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.
|
|
15576
|
+
* @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.
|
|
15577
|
+
* @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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15578
|
+
* @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: **created, modified**
|
|
15579
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15580
|
+
* @throws {RequiredError}
|
|
15581
|
+
*/
|
|
15582
|
+
listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<PendingApproval>>;
|
|
15583
|
+
/**
|
|
15584
|
+
* This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
|
15585
|
+
* @summary Rejects an access request approval.
|
|
15586
|
+
* @param {string} approvalId The id of the approval.
|
|
15587
|
+
* @param {CommentDto} [commentDto] Reviewer\'s comment.
|
|
15588
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15589
|
+
* @throws {RequiredError}
|
|
15590
|
+
*/
|
|
15591
|
+
rejectAccessRequest(approvalId: string, commentDto?: CommentDto, axiosOptions?: any): AxiosPromise<object>;
|
|
15592
|
+
};
|
|
15593
|
+
/**
|
|
15594
|
+
* Request parameters for approveAccessRequest operation in AccessRequestApprovalsApi.
|
|
15595
|
+
* @export
|
|
15596
|
+
* @interface AccessRequestApprovalsApiApproveAccessRequestRequest
|
|
15597
|
+
*/
|
|
15598
|
+
export interface AccessRequestApprovalsApiApproveAccessRequestRequest {
|
|
15599
|
+
/**
|
|
15600
|
+
* The id of the approval.
|
|
15601
|
+
* @type {string}
|
|
15602
|
+
* @memberof AccessRequestApprovalsApiApproveAccessRequest
|
|
15603
|
+
*/
|
|
15604
|
+
readonly approvalId: string;
|
|
15605
|
+
/**
|
|
15606
|
+
* Reviewer\'s comment.
|
|
15607
|
+
* @type {CommentDto}
|
|
15608
|
+
* @memberof AccessRequestApprovalsApiApproveAccessRequest
|
|
15609
|
+
*/
|
|
15610
|
+
readonly commentDto?: CommentDto;
|
|
15611
|
+
}
|
|
15612
|
+
/**
|
|
15613
|
+
* Request parameters for forwardAccessRequest operation in AccessRequestApprovalsApi.
|
|
15614
|
+
* @export
|
|
15615
|
+
* @interface AccessRequestApprovalsApiForwardAccessRequestRequest
|
|
15616
|
+
*/
|
|
15617
|
+
export interface AccessRequestApprovalsApiForwardAccessRequestRequest {
|
|
15618
|
+
/**
|
|
15619
|
+
* The id of the approval.
|
|
15620
|
+
* @type {string}
|
|
15621
|
+
* @memberof AccessRequestApprovalsApiForwardAccessRequest
|
|
15622
|
+
*/
|
|
15623
|
+
readonly approvalId: string;
|
|
15624
|
+
/**
|
|
15625
|
+
* Information about the forwarded approval.
|
|
15626
|
+
* @type {ForwardApprovalDto}
|
|
15627
|
+
* @memberof AccessRequestApprovalsApiForwardAccessRequest
|
|
15628
|
+
*/
|
|
15629
|
+
readonly forwardApprovalDto: ForwardApprovalDto;
|
|
15630
|
+
}
|
|
15631
|
+
/**
|
|
15632
|
+
* Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsApi.
|
|
15633
|
+
* @export
|
|
15634
|
+
* @interface AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest
|
|
15635
|
+
*/
|
|
15636
|
+
export interface AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest {
|
|
15637
|
+
/**
|
|
15638
|
+
* The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15639
|
+
* @type {string}
|
|
15640
|
+
* @memberof AccessRequestApprovalsApiGetAccessRequestApprovalSummary
|
|
15641
|
+
*/
|
|
15642
|
+
readonly ownerId?: string;
|
|
15643
|
+
/**
|
|
15644
|
+
* From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
|
|
15645
|
+
* @type {string}
|
|
15646
|
+
* @memberof AccessRequestApprovalsApiGetAccessRequestApprovalSummary
|
|
15647
|
+
*/
|
|
15648
|
+
readonly fromDate?: string;
|
|
15649
|
+
}
|
|
15650
|
+
/**
|
|
15651
|
+
* Request parameters for listCompletedApprovals operation in AccessRequestApprovalsApi.
|
|
15652
|
+
* @export
|
|
15653
|
+
* @interface AccessRequestApprovalsApiListCompletedApprovalsRequest
|
|
15654
|
+
*/
|
|
15655
|
+
export interface AccessRequestApprovalsApiListCompletedApprovalsRequest {
|
|
15656
|
+
/**
|
|
15657
|
+
* If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15658
|
+
* @type {string}
|
|
15659
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15660
|
+
*/
|
|
15661
|
+
readonly ownerId?: string;
|
|
15662
|
+
/**
|
|
15663
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
15664
|
+
* @type {number}
|
|
15665
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15666
|
+
*/
|
|
15667
|
+
readonly limit?: number;
|
|
15668
|
+
/**
|
|
15669
|
+
* 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.
|
|
15670
|
+
* @type {number}
|
|
15671
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15672
|
+
*/
|
|
15673
|
+
readonly offset?: number;
|
|
15674
|
+
/**
|
|
15675
|
+
* 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.
|
|
15676
|
+
* @type {boolean}
|
|
15677
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15678
|
+
*/
|
|
15679
|
+
readonly count?: boolean;
|
|
15680
|
+
/**
|
|
15681
|
+
* 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15682
|
+
* @type {string}
|
|
15683
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15684
|
+
*/
|
|
15685
|
+
readonly filters?: string;
|
|
15686
|
+
/**
|
|
15687
|
+
* 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: **created, modified**
|
|
15688
|
+
* @type {string}
|
|
15689
|
+
* @memberof AccessRequestApprovalsApiListCompletedApprovals
|
|
15690
|
+
*/
|
|
15691
|
+
readonly sorters?: string;
|
|
15692
|
+
}
|
|
15693
|
+
/**
|
|
15694
|
+
* Request parameters for listPendingApprovals operation in AccessRequestApprovalsApi.
|
|
15695
|
+
* @export
|
|
15696
|
+
* @interface AccessRequestApprovalsApiListPendingApprovalsRequest
|
|
15697
|
+
*/
|
|
15698
|
+
export interface AccessRequestApprovalsApiListPendingApprovalsRequest {
|
|
15699
|
+
/**
|
|
15700
|
+
* If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
15701
|
+
* @type {string}
|
|
15702
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15703
|
+
*/
|
|
15704
|
+
readonly ownerId?: string;
|
|
15705
|
+
/**
|
|
15706
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
15707
|
+
* @type {number}
|
|
15708
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15709
|
+
*/
|
|
15710
|
+
readonly limit?: number;
|
|
15711
|
+
/**
|
|
15712
|
+
* 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.
|
|
15713
|
+
* @type {number}
|
|
15714
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15715
|
+
*/
|
|
15716
|
+
readonly offset?: number;
|
|
15717
|
+
/**
|
|
15718
|
+
* 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.
|
|
15719
|
+
* @type {boolean}
|
|
15720
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15721
|
+
*/
|
|
15722
|
+
readonly count?: boolean;
|
|
15723
|
+
/**
|
|
15724
|
+
* 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le*
|
|
15725
|
+
* @type {string}
|
|
15726
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15727
|
+
*/
|
|
15728
|
+
readonly filters?: string;
|
|
15729
|
+
/**
|
|
15730
|
+
* 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: **created, modified**
|
|
15731
|
+
* @type {string}
|
|
15732
|
+
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
15733
|
+
*/
|
|
15734
|
+
readonly sorters?: string;
|
|
15735
|
+
}
|
|
15736
|
+
/**
|
|
15737
|
+
* Request parameters for rejectAccessRequest operation in AccessRequestApprovalsApi.
|
|
15738
|
+
* @export
|
|
15739
|
+
* @interface AccessRequestApprovalsApiRejectAccessRequestRequest
|
|
15740
|
+
*/
|
|
15741
|
+
export interface AccessRequestApprovalsApiRejectAccessRequestRequest {
|
|
15742
|
+
/**
|
|
15743
|
+
* The id of the approval.
|
|
15744
|
+
* @type {string}
|
|
15745
|
+
* @memberof AccessRequestApprovalsApiRejectAccessRequest
|
|
15746
|
+
*/
|
|
15747
|
+
readonly approvalId: string;
|
|
15748
|
+
/**
|
|
15749
|
+
* Reviewer\'s comment.
|
|
15750
|
+
* @type {CommentDto}
|
|
15751
|
+
* @memberof AccessRequestApprovalsApiRejectAccessRequest
|
|
15752
|
+
*/
|
|
15753
|
+
readonly commentDto?: CommentDto;
|
|
15754
|
+
}
|
|
15755
|
+
/**
|
|
15756
|
+
* AccessRequestApprovalsApi - object-oriented interface
|
|
15757
|
+
* @export
|
|
15758
|
+
* @class AccessRequestApprovalsApi
|
|
15759
|
+
* @extends {BaseAPI}
|
|
15760
|
+
*/
|
|
15761
|
+
export declare class AccessRequestApprovalsApi extends BaseAPI {
|
|
15762
|
+
/**
|
|
15763
|
+
* This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15764
|
+
* @summary Approves an access request approval.
|
|
15765
|
+
* @param {AccessRequestApprovalsApiApproveAccessRequestRequest} requestParameters Request parameters.
|
|
15766
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15767
|
+
* @throws {RequiredError}
|
|
15768
|
+
* @memberof AccessRequestApprovalsApi
|
|
15769
|
+
*/
|
|
15770
|
+
approveAccessRequest(requestParameters: AccessRequestApprovalsApiApproveAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15771
|
+
/**
|
|
15772
|
+
* This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
15773
|
+
* @summary Forwards an access request approval.
|
|
15774
|
+
* @param {AccessRequestApprovalsApiForwardAccessRequestRequest} requestParameters Request parameters.
|
|
15775
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15776
|
+
* @throws {RequiredError}
|
|
15777
|
+
* @memberof AccessRequestApprovalsApi
|
|
15778
|
+
*/
|
|
15779
|
+
forwardAccessRequest(requestParameters: AccessRequestApprovalsApiForwardAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15780
|
+
/**
|
|
15781
|
+
* This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15782
|
+
* @summary Get the number of access-requests-approvals
|
|
15783
|
+
* @param {AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters.
|
|
15784
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15785
|
+
* @throws {RequiredError}
|
|
15786
|
+
* @memberof AccessRequestApprovalsApi
|
|
15787
|
+
*/
|
|
15788
|
+
getAccessRequestApprovalSummary(requestParameters?: AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApprovalSummary, any>>;
|
|
15789
|
+
/**
|
|
15790
|
+
* This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
|
15791
|
+
* @summary Completed Access Request Approvals List
|
|
15792
|
+
* @param {AccessRequestApprovalsApiListCompletedApprovalsRequest} requestParameters Request parameters.
|
|
15793
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15794
|
+
* @throws {RequiredError}
|
|
15795
|
+
* @memberof AccessRequestApprovalsApi
|
|
15796
|
+
*/
|
|
15797
|
+
listCompletedApprovals(requestParameters?: AccessRequestApprovalsApiListCompletedApprovalsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompletedApproval[], any>>;
|
|
15798
|
+
/**
|
|
15799
|
+
* This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.
|
|
15800
|
+
* @summary Pending Access Request Approvals List
|
|
15801
|
+
* @param {AccessRequestApprovalsApiListPendingApprovalsRequest} requestParameters Request parameters.
|
|
15802
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15803
|
+
* @throws {RequiredError}
|
|
15804
|
+
* @memberof AccessRequestApprovalsApi
|
|
15805
|
+
*/
|
|
15806
|
+
listPendingApprovals(requestParameters?: AccessRequestApprovalsApiListPendingApprovalsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PendingApproval[], any>>;
|
|
15807
|
+
/**
|
|
15808
|
+
* This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
|
15809
|
+
* @summary Rejects an access request approval.
|
|
15810
|
+
* @param {AccessRequestApprovalsApiRejectAccessRequestRequest} requestParameters Request parameters.
|
|
15811
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15812
|
+
* @throws {RequiredError}
|
|
15813
|
+
* @memberof AccessRequestApprovalsApi
|
|
15814
|
+
*/
|
|
15815
|
+
rejectAccessRequest(requestParameters: AccessRequestApprovalsApiRejectAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15816
|
+
}
|
|
15817
|
+
/**
|
|
15818
|
+
* AccessRequestsApi - axios parameter creator
|
|
15819
|
+
* @export
|
|
15820
|
+
*/
|
|
15821
|
+
export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15822
|
+
/**
|
|
15823
|
+
* This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.
|
|
15824
|
+
* @summary Cancel Access Request
|
|
15825
|
+
* @param {CancelAccessRequest} cancelAccessRequest
|
|
15826
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15827
|
+
* @throws {RequiredError}
|
|
15828
|
+
*/
|
|
15829
|
+
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15830
|
+
/**
|
|
15831
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
15832
|
+
* @summary Submit an Access Request
|
|
15833
|
+
* @param {AccessRequest} accessRequest
|
|
15834
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15835
|
+
* @throws {RequiredError}
|
|
15836
|
+
*/
|
|
15837
|
+
createAccessRequest: (accessRequest: AccessRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15838
|
+
/**
|
|
15839
|
+
* This endpoint returns the current access-request configuration.
|
|
15840
|
+
* @summary Get Access Request Configuration
|
|
15841
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15842
|
+
* @throws {RequiredError}
|
|
15843
|
+
*/
|
|
15844
|
+
getAccessRequestConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15845
|
+
/**
|
|
15846
|
+
* The Access Request Status API returns a list of access request statuses based on the specified query parameters. Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.
|
|
15847
|
+
* @summary Access Request Status
|
|
15848
|
+
* @param {string} [requestedFor] Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
15849
|
+
* @param {string} [requestedBy] Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
15850
|
+
* @param {string} [regardingIdentity] Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
|
|
15851
|
+
* @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.
|
|
15852
|
+
* @param {number} [limit] Max number of results to return.
|
|
15853
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
15854
|
+
* @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: **accountActivityItemId**: *eq, in*
|
|
15855
|
+
* @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: **created, modified, accountActivityItemId**
|
|
15856
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15857
|
+
* @throws {RequiredError}
|
|
15858
|
+
*/
|
|
15859
|
+
listAccessRequestStatus: (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15860
|
+
/**
|
|
15861
|
+
* This endpoint replaces the current access-request configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
15862
|
+
* @summary Update Access Request Configuration
|
|
15863
|
+
* @param {AccessRequestConfig} accessRequestConfig
|
|
15864
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15865
|
+
* @throws {RequiredError}
|
|
15866
|
+
*/
|
|
15867
|
+
updateAccessRequestConfig: (accessRequestConfig: AccessRequestConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15868
|
+
};
|
|
15869
|
+
/**
|
|
15870
|
+
* AccessRequestsApi - functional programming interface
|
|
15871
|
+
* @export
|
|
15872
|
+
*/
|
|
15873
|
+
export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
15874
|
+
/**
|
|
15875
|
+
* This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.
|
|
15876
|
+
* @summary Cancel Access Request
|
|
15877
|
+
* @param {CancelAccessRequest} cancelAccessRequest
|
|
15878
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15879
|
+
* @throws {RequiredError}
|
|
15880
|
+
*/
|
|
15881
|
+
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15882
|
+
/**
|
|
15883
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
15884
|
+
* @summary Submit an Access Request
|
|
15885
|
+
* @param {AccessRequest} accessRequest
|
|
15886
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15887
|
+
* @throws {RequiredError}
|
|
15888
|
+
*/
|
|
15889
|
+
createAccessRequest(accessRequest: AccessRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15890
|
+
/**
|
|
15891
|
+
* This endpoint returns the current access-request configuration.
|
|
15892
|
+
* @summary Get Access Request Configuration
|
|
15893
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15894
|
+
* @throws {RequiredError}
|
|
15895
|
+
*/
|
|
15896
|
+
getAccessRequestConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestConfig>>;
|
|
15897
|
+
/**
|
|
15898
|
+
* The Access Request Status API returns a list of access request statuses based on the specified query parameters. Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.
|
|
15899
|
+
* @summary Access Request Status
|
|
15900
|
+
* @param {string} [requestedFor] Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
15901
|
+
* @param {string} [requestedBy] Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
15902
|
+
* @param {string} [regardingIdentity] Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
|
|
15903
|
+
* @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.
|
|
15904
|
+
* @param {number} [limit] Max number of results to return.
|
|
15905
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
15906
|
+
* @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: **accountActivityItemId**: *eq, in*
|
|
15907
|
+
* @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: **created, modified, accountActivityItemId**
|
|
15908
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
15909
|
+
* @throws {RequiredError}
|
|
15910
|
+
*/
|
|
15911
|
+
listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RequestedItemStatus>>>;
|
|
15912
|
+
/**
|
|
15913
|
+
* This endpoint replaces the current access-request configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
14483
15914
|
* @summary Update Access Request Configuration
|
|
14484
15915
|
* @param {AccessRequestConfig} accessRequestConfig
|
|
14485
15916
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -14501,7 +15932,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
14501
15932
|
*/
|
|
14502
15933
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
14503
15934
|
/**
|
|
14504
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
15935
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
14505
15936
|
* @summary Submit an Access Request
|
|
14506
15937
|
* @param {AccessRequest} accessRequest
|
|
14507
15938
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -14650,7 +16081,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
14650
16081
|
*/
|
|
14651
16082
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
14652
16083
|
/**
|
|
14653
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
16084
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users, see \'/beta/access-request-config\' endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, Access Profiles and Entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
14654
16085
|
* @summary Submit an Access Request
|
|
14655
16086
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
14656
16087
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -15510,7 +16941,7 @@ export declare const CertificationSummariesApiAxiosParamCreator: (configuration?
|
|
|
15510
16941
|
* @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.
|
|
15511
16942
|
* @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.
|
|
15512
16943
|
* @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.
|
|
15513
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
16944
|
+
* @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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
15514
16945
|
* @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: **access.name**
|
|
15515
16946
|
* @param {*} [axiosOptions] Override http request option.
|
|
15516
16947
|
* @throws {RequiredError}
|
|
@@ -15520,7 +16951,7 @@ export declare const CertificationSummariesApiAxiosParamCreator: (configuration?
|
|
|
15520
16951
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
15521
16952
|
* @summary Summary of Certification Decisions
|
|
15522
16953
|
* @param {string} id The certification ID
|
|
15523
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
16954
|
+
* @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: **identitySummary.id**: *eq, in*
|
|
15524
16955
|
* @param {*} [axiosOptions] Override http request option.
|
|
15525
16956
|
* @throws {RequiredError}
|
|
15526
16957
|
*/
|
|
@@ -15561,7 +16992,7 @@ export declare const CertificationSummariesApiFp: (configuration?: Configuration
|
|
|
15561
16992
|
* @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.
|
|
15562
16993
|
* @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.
|
|
15563
16994
|
* @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.
|
|
15564
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
16995
|
+
* @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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
15565
16996
|
* @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: **access.name**
|
|
15566
16997
|
* @param {*} [axiosOptions] Override http request option.
|
|
15567
16998
|
* @throws {RequiredError}
|
|
@@ -15571,7 +17002,7 @@ export declare const CertificationSummariesApiFp: (configuration?: Configuration
|
|
|
15571
17002
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
15572
17003
|
* @summary Summary of Certification Decisions
|
|
15573
17004
|
* @param {string} id The certification ID
|
|
15574
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17005
|
+
* @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: **identitySummary.id**: *eq, in*
|
|
15575
17006
|
* @param {*} [axiosOptions] Override http request option.
|
|
15576
17007
|
* @throws {RequiredError}
|
|
15577
17008
|
*/
|
|
@@ -15612,7 +17043,7 @@ export declare const CertificationSummariesApiFactory: (configuration?: Configur
|
|
|
15612
17043
|
* @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.
|
|
15613
17044
|
* @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.
|
|
15614
17045
|
* @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.
|
|
15615
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17046
|
+
* @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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
15616
17047
|
* @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: **access.name**
|
|
15617
17048
|
* @param {*} [axiosOptions] Override http request option.
|
|
15618
17049
|
* @throws {RequiredError}
|
|
@@ -15622,7 +17053,7 @@ export declare const CertificationSummariesApiFactory: (configuration?: Configur
|
|
|
15622
17053
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
15623
17054
|
* @summary Summary of Certification Decisions
|
|
15624
17055
|
* @param {string} id The certification ID
|
|
15625
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17056
|
+
* @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: **identitySummary.id**: *eq, in*
|
|
15626
17057
|
* @param {*} [axiosOptions] Override http request option.
|
|
15627
17058
|
* @throws {RequiredError}
|
|
15628
17059
|
*/
|
|
@@ -15687,7 +17118,7 @@ export interface CertificationSummariesApiGetIdentityAccessSummariesRequest {
|
|
|
15687
17118
|
*/
|
|
15688
17119
|
readonly count?: boolean;
|
|
15689
17120
|
/**
|
|
15690
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17121
|
+
* 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
15691
17122
|
* @type {string}
|
|
15692
17123
|
* @memberof CertificationSummariesApiGetIdentityAccessSummaries
|
|
15693
17124
|
*/
|
|
@@ -15712,7 +17143,7 @@ export interface CertificationSummariesApiGetIdentityDecisionSummaryRequest {
|
|
|
15712
17143
|
*/
|
|
15713
17144
|
readonly id: string;
|
|
15714
17145
|
/**
|
|
15715
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17146
|
+
* 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: **identitySummary.id**: *eq, in*
|
|
15716
17147
|
* @type {string}
|
|
15717
17148
|
* @memberof CertificationSummariesApiGetIdentityDecisionSummary
|
|
15718
17149
|
*/
|
|
@@ -18932,96 +20363,344 @@ export interface OAuthClientsApiDeleteOauthClientRequest {
|
|
|
18932
20363
|
*/
|
|
18933
20364
|
export interface OAuthClientsApiGetOauthClientRequest {
|
|
18934
20365
|
/**
|
|
18935
|
-
* The OAuth client id
|
|
18936
|
-
* @type {string}
|
|
18937
|
-
* @memberof OAuthClientsApiGetOauthClient
|
|
20366
|
+
* The OAuth client id
|
|
20367
|
+
* @type {string}
|
|
20368
|
+
* @memberof OAuthClientsApiGetOauthClient
|
|
20369
|
+
*/
|
|
20370
|
+
readonly id: string;
|
|
20371
|
+
}
|
|
20372
|
+
/**
|
|
20373
|
+
* Request parameters for listOauthClients operation in OAuthClientsApi.
|
|
20374
|
+
* @export
|
|
20375
|
+
* @interface OAuthClientsApiListOauthClientsRequest
|
|
20376
|
+
*/
|
|
20377
|
+
export interface OAuthClientsApiListOauthClientsRequest {
|
|
20378
|
+
/**
|
|
20379
|
+
* 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: **lastUsed**: *le, isnull*
|
|
20380
|
+
* @type {string}
|
|
20381
|
+
* @memberof OAuthClientsApiListOauthClients
|
|
20382
|
+
*/
|
|
20383
|
+
readonly filters?: string;
|
|
20384
|
+
}
|
|
20385
|
+
/**
|
|
20386
|
+
* Request parameters for patchOauthClient operation in OAuthClientsApi.
|
|
20387
|
+
* @export
|
|
20388
|
+
* @interface OAuthClientsApiPatchOauthClientRequest
|
|
20389
|
+
*/
|
|
20390
|
+
export interface OAuthClientsApiPatchOauthClientRequest {
|
|
20391
|
+
/**
|
|
20392
|
+
* The OAuth client id
|
|
20393
|
+
* @type {string}
|
|
20394
|
+
* @memberof OAuthClientsApiPatchOauthClient
|
|
20395
|
+
*/
|
|
20396
|
+
readonly id: string;
|
|
20397
|
+
/**
|
|
20398
|
+
* A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
|
|
20399
|
+
* @type {Array<JsonPatchOperation>}
|
|
20400
|
+
* @memberof OAuthClientsApiPatchOauthClient
|
|
20401
|
+
*/
|
|
20402
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
20403
|
+
}
|
|
20404
|
+
/**
|
|
20405
|
+
* OAuthClientsApi - object-oriented interface
|
|
20406
|
+
* @export
|
|
20407
|
+
* @class OAuthClientsApi
|
|
20408
|
+
* @extends {BaseAPI}
|
|
20409
|
+
*/
|
|
20410
|
+
export declare class OAuthClientsApi extends BaseAPI {
|
|
20411
|
+
/**
|
|
20412
|
+
* This creates an OAuth client.
|
|
20413
|
+
* @summary Create OAuth Client
|
|
20414
|
+
* @param {OAuthClientsApiCreateOauthClientRequest} requestParameters Request parameters.
|
|
20415
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20416
|
+
* @throws {RequiredError}
|
|
20417
|
+
* @memberof OAuthClientsApi
|
|
20418
|
+
*/
|
|
20419
|
+
createOauthClient(requestParameters: OAuthClientsApiCreateOauthClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOAuthClientResponse, any>>;
|
|
20420
|
+
/**
|
|
20421
|
+
* This deletes an OAuth client.
|
|
20422
|
+
* @summary Delete OAuth Client
|
|
20423
|
+
* @param {OAuthClientsApiDeleteOauthClientRequest} requestParameters Request parameters.
|
|
20424
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20425
|
+
* @throws {RequiredError}
|
|
20426
|
+
* @memberof OAuthClientsApi
|
|
20427
|
+
*/
|
|
20428
|
+
deleteOauthClient(requestParameters: OAuthClientsApiDeleteOauthClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
20429
|
+
/**
|
|
20430
|
+
* This gets details of an OAuth client.
|
|
20431
|
+
* @summary Get OAuth Client
|
|
20432
|
+
* @param {OAuthClientsApiGetOauthClientRequest} requestParameters Request parameters.
|
|
20433
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20434
|
+
* @throws {RequiredError}
|
|
20435
|
+
* @memberof OAuthClientsApi
|
|
20436
|
+
*/
|
|
20437
|
+
getOauthClient(requestParameters: OAuthClientsApiGetOauthClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOAuthClientResponse, any>>;
|
|
20438
|
+
/**
|
|
20439
|
+
* This gets a list of OAuth clients.
|
|
20440
|
+
* @summary List OAuth Clients
|
|
20441
|
+
* @param {OAuthClientsApiListOauthClientsRequest} requestParameters Request parameters.
|
|
20442
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20443
|
+
* @throws {RequiredError}
|
|
20444
|
+
* @memberof OAuthClientsApi
|
|
20445
|
+
*/
|
|
20446
|
+
listOauthClients(requestParameters?: OAuthClientsApiListOauthClientsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOAuthClientResponse[], any>>;
|
|
20447
|
+
/**
|
|
20448
|
+
* This performs a targeted update to the field(s) of an OAuth client.
|
|
20449
|
+
* @summary Patch OAuth Client
|
|
20450
|
+
* @param {OAuthClientsApiPatchOauthClientRequest} requestParameters Request parameters.
|
|
20451
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20452
|
+
* @throws {RequiredError}
|
|
20453
|
+
* @memberof OAuthClientsApi
|
|
20454
|
+
*/
|
|
20455
|
+
patchOauthClient(requestParameters: OAuthClientsApiPatchOauthClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOAuthClientResponse, any>>;
|
|
20456
|
+
}
|
|
20457
|
+
/**
|
|
20458
|
+
* PasswordConfigurationApi - axios parameter creator
|
|
20459
|
+
* @export
|
|
20460
|
+
*/
|
|
20461
|
+
export declare const PasswordConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20462
|
+
/**
|
|
20463
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20464
|
+
* @summary Create Password Org Config
|
|
20465
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20466
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20467
|
+
* @throws {RequiredError}
|
|
20468
|
+
*/
|
|
20469
|
+
createPasswordOrgConfig: (passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20470
|
+
/**
|
|
20471
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20472
|
+
* @summary Get Password Org Config
|
|
20473
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20474
|
+
* @throws {RequiredError}
|
|
20475
|
+
*/
|
|
20476
|
+
getPasswordOrgConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20477
|
+
/**
|
|
20478
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20479
|
+
* @summary Update Password Org Config
|
|
20480
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20481
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20482
|
+
* @throws {RequiredError}
|
|
20483
|
+
*/
|
|
20484
|
+
updatePasswordOrgConfig: (passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20485
|
+
};
|
|
20486
|
+
/**
|
|
20487
|
+
* PasswordConfigurationApi - functional programming interface
|
|
20488
|
+
* @export
|
|
20489
|
+
*/
|
|
20490
|
+
export declare const PasswordConfigurationApiFp: (configuration?: Configuration) => {
|
|
20491
|
+
/**
|
|
20492
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20493
|
+
* @summary Create Password Org Config
|
|
20494
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20495
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20496
|
+
* @throws {RequiredError}
|
|
20497
|
+
*/
|
|
20498
|
+
createPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20499
|
+
/**
|
|
20500
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20501
|
+
* @summary Get Password Org Config
|
|
20502
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20503
|
+
* @throws {RequiredError}
|
|
20504
|
+
*/
|
|
20505
|
+
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20506
|
+
/**
|
|
20507
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20508
|
+
* @summary Update Password Org Config
|
|
20509
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20510
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20511
|
+
* @throws {RequiredError}
|
|
20512
|
+
*/
|
|
20513
|
+
updatePasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20514
|
+
};
|
|
20515
|
+
/**
|
|
20516
|
+
* PasswordConfigurationApi - factory interface
|
|
20517
|
+
* @export
|
|
20518
|
+
*/
|
|
20519
|
+
export declare const PasswordConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20520
|
+
/**
|
|
20521
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20522
|
+
* @summary Create Password Org Config
|
|
20523
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20524
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20525
|
+
* @throws {RequiredError}
|
|
20526
|
+
*/
|
|
20527
|
+
createPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20528
|
+
/**
|
|
20529
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20530
|
+
* @summary Get Password Org Config
|
|
20531
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20532
|
+
* @throws {RequiredError}
|
|
20533
|
+
*/
|
|
20534
|
+
getPasswordOrgConfig(axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20535
|
+
/**
|
|
20536
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20537
|
+
* @summary Update Password Org Config
|
|
20538
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20539
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20540
|
+
* @throws {RequiredError}
|
|
20541
|
+
*/
|
|
20542
|
+
updatePasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20543
|
+
};
|
|
20544
|
+
/**
|
|
20545
|
+
* Request parameters for createPasswordOrgConfig operation in PasswordConfigurationApi.
|
|
20546
|
+
* @export
|
|
20547
|
+
* @interface PasswordConfigurationApiCreatePasswordOrgConfigRequest
|
|
20548
|
+
*/
|
|
20549
|
+
export interface PasswordConfigurationApiCreatePasswordOrgConfigRequest {
|
|
20550
|
+
/**
|
|
20551
|
+
*
|
|
20552
|
+
* @type {PasswordOrgConfig}
|
|
20553
|
+
* @memberof PasswordConfigurationApiCreatePasswordOrgConfig
|
|
20554
|
+
*/
|
|
20555
|
+
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
20556
|
+
}
|
|
20557
|
+
/**
|
|
20558
|
+
* Request parameters for updatePasswordOrgConfig operation in PasswordConfigurationApi.
|
|
20559
|
+
* @export
|
|
20560
|
+
* @interface PasswordConfigurationApiUpdatePasswordOrgConfigRequest
|
|
20561
|
+
*/
|
|
20562
|
+
export interface PasswordConfigurationApiUpdatePasswordOrgConfigRequest {
|
|
20563
|
+
/**
|
|
20564
|
+
*
|
|
20565
|
+
* @type {PasswordOrgConfig}
|
|
20566
|
+
* @memberof PasswordConfigurationApiUpdatePasswordOrgConfig
|
|
20567
|
+
*/
|
|
20568
|
+
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
20569
|
+
}
|
|
20570
|
+
/**
|
|
20571
|
+
* PasswordConfigurationApi - object-oriented interface
|
|
20572
|
+
* @export
|
|
20573
|
+
* @class PasswordConfigurationApi
|
|
20574
|
+
* @extends {BaseAPI}
|
|
20575
|
+
*/
|
|
20576
|
+
export declare class PasswordConfigurationApi extends BaseAPI {
|
|
20577
|
+
/**
|
|
20578
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20579
|
+
* @summary Create Password Org Config
|
|
20580
|
+
* @param {PasswordConfigurationApiCreatePasswordOrgConfigRequest} requestParameters Request parameters.
|
|
20581
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20582
|
+
* @throws {RequiredError}
|
|
20583
|
+
* @memberof PasswordConfigurationApi
|
|
20584
|
+
*/
|
|
20585
|
+
createPasswordOrgConfig(requestParameters: PasswordConfigurationApiCreatePasswordOrgConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
20586
|
+
/**
|
|
20587
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20588
|
+
* @summary Get Password Org Config
|
|
20589
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20590
|
+
* @throws {RequiredError}
|
|
20591
|
+
* @memberof PasswordConfigurationApi
|
|
20592
|
+
*/
|
|
20593
|
+
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
20594
|
+
/**
|
|
20595
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20596
|
+
* @summary Update Password Org Config
|
|
20597
|
+
* @param {PasswordConfigurationApiUpdatePasswordOrgConfigRequest} requestParameters Request parameters.
|
|
20598
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20599
|
+
* @throws {RequiredError}
|
|
20600
|
+
* @memberof PasswordConfigurationApi
|
|
18938
20601
|
*/
|
|
18939
|
-
|
|
20602
|
+
updatePasswordOrgConfig(requestParameters: PasswordConfigurationApiUpdatePasswordOrgConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
18940
20603
|
}
|
|
18941
20604
|
/**
|
|
18942
|
-
*
|
|
20605
|
+
* PasswordDictionaryApi - axios parameter creator
|
|
18943
20606
|
* @export
|
|
18944
|
-
* @interface OAuthClientsApiListOauthClientsRequest
|
|
18945
20607
|
*/
|
|
18946
|
-
export
|
|
20608
|
+
export declare const PasswordDictionaryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18947
20609
|
/**
|
|
18948
|
-
*
|
|
18949
|
-
* @
|
|
18950
|
-
* @
|
|
20610
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20611
|
+
* @summary Get Password Dictionary
|
|
20612
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20613
|
+
* @throws {RequiredError}
|
|
18951
20614
|
*/
|
|
18952
|
-
|
|
18953
|
-
|
|
20615
|
+
getPasswordDictionary: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20616
|
+
/**
|
|
20617
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20618
|
+
* @summary Update Password Dictionary
|
|
20619
|
+
* @param {any} [file]
|
|
20620
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20621
|
+
* @throws {RequiredError}
|
|
20622
|
+
*/
|
|
20623
|
+
updatePasswordDictionary: (file?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20624
|
+
};
|
|
18954
20625
|
/**
|
|
18955
|
-
*
|
|
20626
|
+
* PasswordDictionaryApi - functional programming interface
|
|
18956
20627
|
* @export
|
|
18957
|
-
* @interface OAuthClientsApiPatchOauthClientRequest
|
|
18958
20628
|
*/
|
|
18959
|
-
export
|
|
20629
|
+
export declare const PasswordDictionaryApiFp: (configuration?: Configuration) => {
|
|
18960
20630
|
/**
|
|
18961
|
-
*
|
|
18962
|
-
* @
|
|
18963
|
-
* @
|
|
20631
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20632
|
+
* @summary Get Password Dictionary
|
|
20633
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20634
|
+
* @throws {RequiredError}
|
|
18964
20635
|
*/
|
|
18965
|
-
|
|
20636
|
+
getPasswordDictionary(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
18966
20637
|
/**
|
|
18967
|
-
*
|
|
18968
|
-
* @
|
|
18969
|
-
* @
|
|
20638
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20639
|
+
* @summary Update Password Dictionary
|
|
20640
|
+
* @param {any} [file]
|
|
20641
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20642
|
+
* @throws {RequiredError}
|
|
18970
20643
|
*/
|
|
18971
|
-
|
|
18972
|
-
}
|
|
20644
|
+
updatePasswordDictionary(file?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
20645
|
+
};
|
|
18973
20646
|
/**
|
|
18974
|
-
*
|
|
20647
|
+
* PasswordDictionaryApi - factory interface
|
|
18975
20648
|
* @export
|
|
18976
|
-
* @class OAuthClientsApi
|
|
18977
|
-
* @extends {BaseAPI}
|
|
18978
20649
|
*/
|
|
18979
|
-
export declare
|
|
20650
|
+
export declare const PasswordDictionaryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18980
20651
|
/**
|
|
18981
|
-
* This
|
|
18982
|
-
* @summary
|
|
18983
|
-
* @param {OAuthClientsApiCreateOauthClientRequest} requestParameters Request parameters.
|
|
20652
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20653
|
+
* @summary Get Password Dictionary
|
|
18984
20654
|
* @param {*} [axiosOptions] Override http request option.
|
|
18985
20655
|
* @throws {RequiredError}
|
|
18986
|
-
* @memberof OAuthClientsApi
|
|
18987
20656
|
*/
|
|
18988
|
-
|
|
20657
|
+
getPasswordDictionary(axiosOptions?: any): AxiosPromise<string>;
|
|
18989
20658
|
/**
|
|
18990
|
-
* This
|
|
18991
|
-
* @summary
|
|
18992
|
-
* @param {
|
|
20659
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20660
|
+
* @summary Update Password Dictionary
|
|
20661
|
+
* @param {any} [file]
|
|
18993
20662
|
* @param {*} [axiosOptions] Override http request option.
|
|
18994
20663
|
* @throws {RequiredError}
|
|
18995
|
-
* @memberof OAuthClientsApi
|
|
18996
20664
|
*/
|
|
18997
|
-
|
|
20665
|
+
updatePasswordDictionary(file?: any, axiosOptions?: any): AxiosPromise<void>;
|
|
20666
|
+
};
|
|
20667
|
+
/**
|
|
20668
|
+
* Request parameters for updatePasswordDictionary operation in PasswordDictionaryApi.
|
|
20669
|
+
* @export
|
|
20670
|
+
* @interface PasswordDictionaryApiUpdatePasswordDictionaryRequest
|
|
20671
|
+
*/
|
|
20672
|
+
export interface PasswordDictionaryApiUpdatePasswordDictionaryRequest {
|
|
18998
20673
|
/**
|
|
18999
|
-
*
|
|
19000
|
-
* @
|
|
19001
|
-
* @
|
|
19002
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
19003
|
-
* @throws {RequiredError}
|
|
19004
|
-
* @memberof OAuthClientsApi
|
|
20674
|
+
*
|
|
20675
|
+
* @type {any}
|
|
20676
|
+
* @memberof PasswordDictionaryApiUpdatePasswordDictionary
|
|
19005
20677
|
*/
|
|
19006
|
-
|
|
20678
|
+
readonly file?: any;
|
|
20679
|
+
}
|
|
20680
|
+
/**
|
|
20681
|
+
* PasswordDictionaryApi - object-oriented interface
|
|
20682
|
+
* @export
|
|
20683
|
+
* @class PasswordDictionaryApi
|
|
20684
|
+
* @extends {BaseAPI}
|
|
20685
|
+
*/
|
|
20686
|
+
export declare class PasswordDictionaryApi extends BaseAPI {
|
|
19007
20687
|
/**
|
|
19008
|
-
* This gets
|
|
19009
|
-
* @summary
|
|
19010
|
-
* @param {OAuthClientsApiListOauthClientsRequest} requestParameters Request parameters.
|
|
20688
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20689
|
+
* @summary Get Password Dictionary
|
|
19011
20690
|
* @param {*} [axiosOptions] Override http request option.
|
|
19012
20691
|
* @throws {RequiredError}
|
|
19013
|
-
* @memberof
|
|
20692
|
+
* @memberof PasswordDictionaryApi
|
|
19014
20693
|
*/
|
|
19015
|
-
|
|
20694
|
+
getPasswordDictionary(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
19016
20695
|
/**
|
|
19017
|
-
* This
|
|
19018
|
-
* @summary
|
|
19019
|
-
* @param {
|
|
20696
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20697
|
+
* @summary Update Password Dictionary
|
|
20698
|
+
* @param {PasswordDictionaryApiUpdatePasswordDictionaryRequest} requestParameters Request parameters.
|
|
19020
20699
|
* @param {*} [axiosOptions] Override http request option.
|
|
19021
20700
|
* @throws {RequiredError}
|
|
19022
|
-
* @memberof
|
|
20701
|
+
* @memberof PasswordDictionaryApi
|
|
19023
20702
|
*/
|
|
19024
|
-
|
|
20703
|
+
updatePasswordDictionary(requestParameters?: PasswordDictionaryApiUpdatePasswordDictionaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
19025
20704
|
}
|
|
19026
20705
|
/**
|
|
19027
20706
|
* PasswordManagementApi - axios parameter creator
|
|
@@ -19133,59 +20812,342 @@ export interface PasswordManagementApiGetPasswordChangeStatusRequest {
|
|
|
19133
20812
|
*/
|
|
19134
20813
|
export interface PasswordManagementApiQueryPasswordInfoRequest {
|
|
19135
20814
|
/**
|
|
19136
|
-
*
|
|
19137
|
-
* @type {PasswordInfoQueryDTO}
|
|
19138
|
-
* @memberof PasswordManagementApiQueryPasswordInfo
|
|
20815
|
+
*
|
|
20816
|
+
* @type {PasswordInfoQueryDTO}
|
|
20817
|
+
* @memberof PasswordManagementApiQueryPasswordInfo
|
|
20818
|
+
*/
|
|
20819
|
+
readonly passwordInfoQueryDTO: PasswordInfoQueryDTO;
|
|
20820
|
+
}
|
|
20821
|
+
/**
|
|
20822
|
+
* Request parameters for setPassword operation in PasswordManagementApi.
|
|
20823
|
+
* @export
|
|
20824
|
+
* @interface PasswordManagementApiSetPasswordRequest
|
|
20825
|
+
*/
|
|
20826
|
+
export interface PasswordManagementApiSetPasswordRequest {
|
|
20827
|
+
/**
|
|
20828
|
+
*
|
|
20829
|
+
* @type {PasswordChangeRequest}
|
|
20830
|
+
* @memberof PasswordManagementApiSetPassword
|
|
20831
|
+
*/
|
|
20832
|
+
readonly passwordChangeRequest: PasswordChangeRequest;
|
|
20833
|
+
}
|
|
20834
|
+
/**
|
|
20835
|
+
* PasswordManagementApi - object-oriented interface
|
|
20836
|
+
* @export
|
|
20837
|
+
* @class PasswordManagementApi
|
|
20838
|
+
* @extends {BaseAPI}
|
|
20839
|
+
*/
|
|
20840
|
+
export declare class PasswordManagementApi extends BaseAPI {
|
|
20841
|
+
/**
|
|
20842
|
+
* This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
|
|
20843
|
+
* @summary Get Password Change Request Status
|
|
20844
|
+
* @param {PasswordManagementApiGetPasswordChangeStatusRequest} requestParameters Request parameters.
|
|
20845
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20846
|
+
* @throws {RequiredError}
|
|
20847
|
+
* @memberof PasswordManagementApi
|
|
20848
|
+
*/
|
|
20849
|
+
getPasswordChangeStatus(requestParameters: PasswordManagementApiGetPasswordChangeStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordStatus, any>>;
|
|
20850
|
+
/**
|
|
20851
|
+
* This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned.
|
|
20852
|
+
* @summary Query Password Info
|
|
20853
|
+
* @param {PasswordManagementApiQueryPasswordInfoRequest} requestParameters Request parameters.
|
|
20854
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20855
|
+
* @throws {RequiredError}
|
|
20856
|
+
* @memberof PasswordManagementApi
|
|
20857
|
+
*/
|
|
20858
|
+
queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfo, any>>;
|
|
20859
|
+
/**
|
|
20860
|
+
* This API is used to set a password for an identity. An identity can change their own password if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password. \"API authority\" refers to a token that only has the \"client_credentials\" grant type.
|
|
20861
|
+
* @summary Set Identity\'s Password
|
|
20862
|
+
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
20863
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20864
|
+
* @throws {RequiredError}
|
|
20865
|
+
* @memberof PasswordManagementApi
|
|
20866
|
+
*/
|
|
20867
|
+
setPassword(requestParameters: PasswordManagementApiSetPasswordRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordChangeResponse, any>>;
|
|
20868
|
+
}
|
|
20869
|
+
/**
|
|
20870
|
+
* PasswordSyncGroupsApi - axios parameter creator
|
|
20871
|
+
* @export
|
|
20872
|
+
*/
|
|
20873
|
+
export declare const PasswordSyncGroupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20874
|
+
/**
|
|
20875
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20876
|
+
* @summary Create Password Sync Group
|
|
20877
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20878
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20879
|
+
* @throws {RequiredError}
|
|
20880
|
+
*/
|
|
20881
|
+
createPasswordSyncGroup: (passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20882
|
+
/**
|
|
20883
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20884
|
+
* @summary Delete Password Sync Group by ID
|
|
20885
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20886
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20887
|
+
* @throws {RequiredError}
|
|
20888
|
+
*/
|
|
20889
|
+
deletePasswordSyncGroup: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20890
|
+
/**
|
|
20891
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
20892
|
+
* @summary Get Password Sync Group by ID
|
|
20893
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
20894
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20895
|
+
* @throws {RequiredError}
|
|
20896
|
+
*/
|
|
20897
|
+
getPasswordSyncGroup: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20898
|
+
/**
|
|
20899
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
20900
|
+
* @summary Get Password Sync Group List
|
|
20901
|
+
* @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.
|
|
20902
|
+
* @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.
|
|
20903
|
+
* @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.
|
|
20904
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20905
|
+
* @throws {RequiredError}
|
|
20906
|
+
*/
|
|
20907
|
+
getPasswordSyncGroups: (limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20908
|
+
/**
|
|
20909
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20910
|
+
* @summary Update Password Sync Group by ID
|
|
20911
|
+
* @param {string} id The ID of password sync group to update.
|
|
20912
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20913
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20914
|
+
* @throws {RequiredError}
|
|
20915
|
+
*/
|
|
20916
|
+
updatePasswordSyncGroup: (id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20917
|
+
};
|
|
20918
|
+
/**
|
|
20919
|
+
* PasswordSyncGroupsApi - functional programming interface
|
|
20920
|
+
* @export
|
|
20921
|
+
*/
|
|
20922
|
+
export declare const PasswordSyncGroupsApiFp: (configuration?: Configuration) => {
|
|
20923
|
+
/**
|
|
20924
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20925
|
+
* @summary Create Password Sync Group
|
|
20926
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20927
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20928
|
+
* @throws {RequiredError}
|
|
20929
|
+
*/
|
|
20930
|
+
createPasswordSyncGroup(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20931
|
+
/**
|
|
20932
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20933
|
+
* @summary Delete Password Sync Group by ID
|
|
20934
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20935
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20936
|
+
* @throws {RequiredError}
|
|
20937
|
+
*/
|
|
20938
|
+
deletePasswordSyncGroup(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
20939
|
+
/**
|
|
20940
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
20941
|
+
* @summary Get Password Sync Group by ID
|
|
20942
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
20943
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20944
|
+
* @throws {RequiredError}
|
|
20945
|
+
*/
|
|
20946
|
+
getPasswordSyncGroup(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20947
|
+
/**
|
|
20948
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
20949
|
+
* @summary Get Password Sync Group List
|
|
20950
|
+
* @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.
|
|
20951
|
+
* @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.
|
|
20952
|
+
* @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.
|
|
20953
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20954
|
+
* @throws {RequiredError}
|
|
20955
|
+
*/
|
|
20956
|
+
getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PasswordSyncGroup>>>;
|
|
20957
|
+
/**
|
|
20958
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20959
|
+
* @summary Update Password Sync Group by ID
|
|
20960
|
+
* @param {string} id The ID of password sync group to update.
|
|
20961
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20962
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20963
|
+
* @throws {RequiredError}
|
|
20964
|
+
*/
|
|
20965
|
+
updatePasswordSyncGroup(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20966
|
+
};
|
|
20967
|
+
/**
|
|
20968
|
+
* PasswordSyncGroupsApi - factory interface
|
|
20969
|
+
* @export
|
|
20970
|
+
*/
|
|
20971
|
+
export declare const PasswordSyncGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20972
|
+
/**
|
|
20973
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20974
|
+
* @summary Create Password Sync Group
|
|
20975
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20976
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20977
|
+
* @throws {RequiredError}
|
|
20978
|
+
*/
|
|
20979
|
+
createPasswordSyncGroup(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
20980
|
+
/**
|
|
20981
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20982
|
+
* @summary Delete Password Sync Group by ID
|
|
20983
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20984
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20985
|
+
* @throws {RequiredError}
|
|
20986
|
+
*/
|
|
20987
|
+
deletePasswordSyncGroup(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
20988
|
+
/**
|
|
20989
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
20990
|
+
* @summary Get Password Sync Group by ID
|
|
20991
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
20992
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20993
|
+
* @throws {RequiredError}
|
|
20994
|
+
*/
|
|
20995
|
+
getPasswordSyncGroup(id: string, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
20996
|
+
/**
|
|
20997
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
20998
|
+
* @summary Get Password Sync Group List
|
|
20999
|
+
* @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.
|
|
21000
|
+
* @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.
|
|
21001
|
+
* @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.
|
|
21002
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21003
|
+
* @throws {RequiredError}
|
|
21004
|
+
*/
|
|
21005
|
+
getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<PasswordSyncGroup>>;
|
|
21006
|
+
/**
|
|
21007
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21008
|
+
* @summary Update Password Sync Group by ID
|
|
21009
|
+
* @param {string} id The ID of password sync group to update.
|
|
21010
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
21011
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21012
|
+
* @throws {RequiredError}
|
|
21013
|
+
*/
|
|
21014
|
+
updatePasswordSyncGroup(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
21015
|
+
};
|
|
21016
|
+
/**
|
|
21017
|
+
* Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21018
|
+
* @export
|
|
21019
|
+
* @interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest
|
|
21020
|
+
*/
|
|
21021
|
+
export interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest {
|
|
21022
|
+
/**
|
|
21023
|
+
*
|
|
21024
|
+
* @type {PasswordSyncGroup}
|
|
21025
|
+
* @memberof PasswordSyncGroupsApiCreatePasswordSyncGroup
|
|
21026
|
+
*/
|
|
21027
|
+
readonly passwordSyncGroup: PasswordSyncGroup;
|
|
21028
|
+
}
|
|
21029
|
+
/**
|
|
21030
|
+
* Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21031
|
+
* @export
|
|
21032
|
+
* @interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest
|
|
21033
|
+
*/
|
|
21034
|
+
export interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest {
|
|
21035
|
+
/**
|
|
21036
|
+
* The ID of password sync group to delete.
|
|
21037
|
+
* @type {string}
|
|
21038
|
+
* @memberof PasswordSyncGroupsApiDeletePasswordSyncGroup
|
|
21039
|
+
*/
|
|
21040
|
+
readonly id: string;
|
|
21041
|
+
}
|
|
21042
|
+
/**
|
|
21043
|
+
* Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21044
|
+
* @export
|
|
21045
|
+
* @interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest
|
|
21046
|
+
*/
|
|
21047
|
+
export interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest {
|
|
21048
|
+
/**
|
|
21049
|
+
* The ID of password sync group to retrieve.
|
|
21050
|
+
* @type {string}
|
|
21051
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroup
|
|
21052
|
+
*/
|
|
21053
|
+
readonly id: string;
|
|
21054
|
+
}
|
|
21055
|
+
/**
|
|
21056
|
+
* Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsApi.
|
|
21057
|
+
* @export
|
|
21058
|
+
* @interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest
|
|
21059
|
+
*/
|
|
21060
|
+
export interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest {
|
|
21061
|
+
/**
|
|
21062
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21063
|
+
* @type {number}
|
|
21064
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
21065
|
+
*/
|
|
21066
|
+
readonly limit?: number;
|
|
21067
|
+
/**
|
|
21068
|
+
* 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.
|
|
21069
|
+
* @type {number}
|
|
21070
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
21071
|
+
*/
|
|
21072
|
+
readonly offset?: number;
|
|
21073
|
+
/**
|
|
21074
|
+
* 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.
|
|
21075
|
+
* @type {boolean}
|
|
21076
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
19139
21077
|
*/
|
|
19140
|
-
readonly
|
|
21078
|
+
readonly count?: boolean;
|
|
19141
21079
|
}
|
|
19142
21080
|
/**
|
|
19143
|
-
* Request parameters for
|
|
21081
|
+
* Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
19144
21082
|
* @export
|
|
19145
|
-
* @interface
|
|
21083
|
+
* @interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest
|
|
19146
21084
|
*/
|
|
19147
|
-
export interface
|
|
21085
|
+
export interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest {
|
|
21086
|
+
/**
|
|
21087
|
+
* The ID of password sync group to update.
|
|
21088
|
+
* @type {string}
|
|
21089
|
+
* @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup
|
|
21090
|
+
*/
|
|
21091
|
+
readonly id: string;
|
|
19148
21092
|
/**
|
|
19149
21093
|
*
|
|
19150
|
-
* @type {
|
|
19151
|
-
* @memberof
|
|
21094
|
+
* @type {PasswordSyncGroup}
|
|
21095
|
+
* @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup
|
|
19152
21096
|
*/
|
|
19153
|
-
readonly
|
|
21097
|
+
readonly passwordSyncGroup: PasswordSyncGroup;
|
|
19154
21098
|
}
|
|
19155
21099
|
/**
|
|
19156
|
-
*
|
|
21100
|
+
* PasswordSyncGroupsApi - object-oriented interface
|
|
19157
21101
|
* @export
|
|
19158
|
-
* @class
|
|
21102
|
+
* @class PasswordSyncGroupsApi
|
|
19159
21103
|
* @extends {BaseAPI}
|
|
19160
21104
|
*/
|
|
19161
|
-
export declare class
|
|
21105
|
+
export declare class PasswordSyncGroupsApi extends BaseAPI {
|
|
19162
21106
|
/**
|
|
19163
|
-
* This API
|
|
19164
|
-
* @summary
|
|
19165
|
-
* @param {
|
|
21107
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
21108
|
+
* @summary Create Password Sync Group
|
|
21109
|
+
* @param {PasswordSyncGroupsApiCreatePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
19166
21110
|
* @param {*} [axiosOptions] Override http request option.
|
|
19167
21111
|
* @throws {RequiredError}
|
|
19168
|
-
* @memberof
|
|
21112
|
+
* @memberof PasswordSyncGroupsApi
|
|
19169
21113
|
*/
|
|
19170
|
-
|
|
21114
|
+
createPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
19171
21115
|
/**
|
|
19172
|
-
* This API
|
|
19173
|
-
* @summary
|
|
19174
|
-
* @param {
|
|
21116
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21117
|
+
* @summary Delete Password Sync Group by ID
|
|
21118
|
+
* @param {PasswordSyncGroupsApiDeletePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
19175
21119
|
* @param {*} [axiosOptions] Override http request option.
|
|
19176
21120
|
* @throws {RequiredError}
|
|
19177
|
-
* @memberof
|
|
21121
|
+
* @memberof PasswordSyncGroupsApi
|
|
19178
21122
|
*/
|
|
19179
|
-
|
|
21123
|
+
deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
19180
21124
|
/**
|
|
19181
|
-
* This API
|
|
19182
|
-
* @summary
|
|
19183
|
-
* @param {
|
|
21125
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
21126
|
+
* @summary Get Password Sync Group by ID
|
|
21127
|
+
* @param {PasswordSyncGroupsApiGetPasswordSyncGroupRequest} requestParameters Request parameters.
|
|
19184
21128
|
* @param {*} [axiosOptions] Override http request option.
|
|
19185
21129
|
* @throws {RequiredError}
|
|
19186
|
-
* @memberof
|
|
21130
|
+
* @memberof PasswordSyncGroupsApi
|
|
19187
21131
|
*/
|
|
19188
|
-
|
|
21132
|
+
getPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
21133
|
+
/**
|
|
21134
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
21135
|
+
* @summary Get Password Sync Group List
|
|
21136
|
+
* @param {PasswordSyncGroupsApiGetPasswordSyncGroupsRequest} requestParameters Request parameters.
|
|
21137
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21138
|
+
* @throws {RequiredError}
|
|
21139
|
+
* @memberof PasswordSyncGroupsApi
|
|
21140
|
+
*/
|
|
21141
|
+
getPasswordSyncGroups(requestParameters?: PasswordSyncGroupsApiGetPasswordSyncGroupsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup[], any>>;
|
|
21142
|
+
/**
|
|
21143
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21144
|
+
* @summary Update Password Sync Group by ID
|
|
21145
|
+
* @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
21146
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21147
|
+
* @throws {RequiredError}
|
|
21148
|
+
* @memberof PasswordSyncGroupsApi
|
|
21149
|
+
*/
|
|
21150
|
+
updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
19189
21151
|
}
|
|
19190
21152
|
/**
|
|
19191
21153
|
* PersonalAccessTokensApi - axios parameter creator
|
|
@@ -19777,6 +21739,379 @@ export declare class RequestableObjectsApi extends BaseAPI {
|
|
|
19777
21739
|
*/
|
|
19778
21740
|
listRequestableObjects(requestParameters?: RequestableObjectsApiListRequestableObjectsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestableObject[], any>>;
|
|
19779
21741
|
}
|
|
21742
|
+
/**
|
|
21743
|
+
* RolesApi - axios parameter creator
|
|
21744
|
+
* @export
|
|
21745
|
+
*/
|
|
21746
|
+
export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21747
|
+
/**
|
|
21748
|
+
* This API creates a Role. There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21749
|
+
* @summary Create a Role
|
|
21750
|
+
* @param {Role} role
|
|
21751
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21752
|
+
* @throws {RequiredError}
|
|
21753
|
+
*/
|
|
21754
|
+
createRole: (role: Role, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21755
|
+
/**
|
|
21756
|
+
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
21757
|
+
* @summary Get a Role
|
|
21758
|
+
* @param {string} id ID of the Role
|
|
21759
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21760
|
+
* @throws {RequiredError}
|
|
21761
|
+
*/
|
|
21762
|
+
getRole: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21763
|
+
/**
|
|
21764
|
+
*
|
|
21765
|
+
* @summary List Identities assigned a Role
|
|
21766
|
+
* @param {string} id ID of the Role for which the assigned Identities are to be listed
|
|
21767
|
+
* @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.
|
|
21768
|
+
* @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.
|
|
21769
|
+
* @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.
|
|
21770
|
+
* @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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co*
|
|
21771
|
+
* @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**, **aliasName**, **email**
|
|
21772
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21773
|
+
* @throws {RequiredError}
|
|
21774
|
+
*/
|
|
21775
|
+
getRoleAssignedIdentities: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21776
|
+
/**
|
|
21777
|
+
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
21778
|
+
* @summary List Roles
|
|
21779
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
21780
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21781
|
+
* @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.
|
|
21782
|
+
* @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.
|
|
21783
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
|
|
21784
|
+
* @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**
|
|
21785
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
21786
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
21787
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21788
|
+
* @throws {RequiredError}
|
|
21789
|
+
*/
|
|
21790
|
+
listRoles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21791
|
+
/**
|
|
21792
|
+
* This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21793
|
+
* @summary Patch a specified Role
|
|
21794
|
+
* @param {string} id ID of the Role to patch
|
|
21795
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
21796
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21797
|
+
* @throws {RequiredError}
|
|
21798
|
+
*/
|
|
21799
|
+
patchRole: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21800
|
+
};
|
|
21801
|
+
/**
|
|
21802
|
+
* RolesApi - functional programming interface
|
|
21803
|
+
* @export
|
|
21804
|
+
*/
|
|
21805
|
+
export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
21806
|
+
/**
|
|
21807
|
+
* This API creates a Role. There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21808
|
+
* @summary Create a Role
|
|
21809
|
+
* @param {Role} role
|
|
21810
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21811
|
+
* @throws {RequiredError}
|
|
21812
|
+
*/
|
|
21813
|
+
createRole(role: Role, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Role>>;
|
|
21814
|
+
/**
|
|
21815
|
+
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
21816
|
+
* @summary Get a Role
|
|
21817
|
+
* @param {string} id ID of the Role
|
|
21818
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21819
|
+
* @throws {RequiredError}
|
|
21820
|
+
*/
|
|
21821
|
+
getRole(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Role>>;
|
|
21822
|
+
/**
|
|
21823
|
+
*
|
|
21824
|
+
* @summary List Identities assigned a Role
|
|
21825
|
+
* @param {string} id ID of the Role for which the assigned Identities are to be listed
|
|
21826
|
+
* @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.
|
|
21827
|
+
* @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.
|
|
21828
|
+
* @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.
|
|
21829
|
+
* @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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co*
|
|
21830
|
+
* @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**, **aliasName**, **email**
|
|
21831
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21832
|
+
* @throws {RequiredError}
|
|
21833
|
+
*/
|
|
21834
|
+
getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleIdentity>>>;
|
|
21835
|
+
/**
|
|
21836
|
+
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
21837
|
+
* @summary List Roles
|
|
21838
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
21839
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21840
|
+
* @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.
|
|
21841
|
+
* @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.
|
|
21842
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
|
|
21843
|
+
* @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**
|
|
21844
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
21845
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
21846
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21847
|
+
* @throws {RequiredError}
|
|
21848
|
+
*/
|
|
21849
|
+
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Role>>>;
|
|
21850
|
+
/**
|
|
21851
|
+
* This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21852
|
+
* @summary Patch a specified Role
|
|
21853
|
+
* @param {string} id ID of the Role to patch
|
|
21854
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
21855
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21856
|
+
* @throws {RequiredError}
|
|
21857
|
+
*/
|
|
21858
|
+
patchRole(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Role>>;
|
|
21859
|
+
};
|
|
21860
|
+
/**
|
|
21861
|
+
* RolesApi - factory interface
|
|
21862
|
+
* @export
|
|
21863
|
+
*/
|
|
21864
|
+
export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
21865
|
+
/**
|
|
21866
|
+
* This API creates a Role. There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21867
|
+
* @summary Create a Role
|
|
21868
|
+
* @param {Role} role
|
|
21869
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21870
|
+
* @throws {RequiredError}
|
|
21871
|
+
*/
|
|
21872
|
+
createRole(role: Role, axiosOptions?: any): AxiosPromise<Role>;
|
|
21873
|
+
/**
|
|
21874
|
+
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
21875
|
+
* @summary Get a Role
|
|
21876
|
+
* @param {string} id ID of the Role
|
|
21877
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21878
|
+
* @throws {RequiredError}
|
|
21879
|
+
*/
|
|
21880
|
+
getRole(id: string, axiosOptions?: any): AxiosPromise<Role>;
|
|
21881
|
+
/**
|
|
21882
|
+
*
|
|
21883
|
+
* @summary List Identities assigned a Role
|
|
21884
|
+
* @param {string} id ID of the Role for which the assigned Identities are to be listed
|
|
21885
|
+
* @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.
|
|
21886
|
+
* @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.
|
|
21887
|
+
* @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.
|
|
21888
|
+
* @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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co*
|
|
21889
|
+
* @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**, **aliasName**, **email**
|
|
21890
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21891
|
+
* @throws {RequiredError}
|
|
21892
|
+
*/
|
|
21893
|
+
getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<RoleIdentity>>;
|
|
21894
|
+
/**
|
|
21895
|
+
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
21896
|
+
* @summary List Roles
|
|
21897
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
21898
|
+
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21899
|
+
* @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.
|
|
21900
|
+
* @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.
|
|
21901
|
+
* @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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
|
|
21902
|
+
* @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**
|
|
21903
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
21904
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
21905
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21906
|
+
* @throws {RequiredError}
|
|
21907
|
+
*/
|
|
21908
|
+
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: any): AxiosPromise<Array<Role>>;
|
|
21909
|
+
/**
|
|
21910
|
+
* This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
21911
|
+
* @summary Patch a specified Role
|
|
21912
|
+
* @param {string} id ID of the Role to patch
|
|
21913
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
21914
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21915
|
+
* @throws {RequiredError}
|
|
21916
|
+
*/
|
|
21917
|
+
patchRole(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<Role>;
|
|
21918
|
+
};
|
|
21919
|
+
/**
|
|
21920
|
+
* Request parameters for createRole operation in RolesApi.
|
|
21921
|
+
* @export
|
|
21922
|
+
* @interface RolesApiCreateRoleRequest
|
|
21923
|
+
*/
|
|
21924
|
+
export interface RolesApiCreateRoleRequest {
|
|
21925
|
+
/**
|
|
21926
|
+
*
|
|
21927
|
+
* @type {Role}
|
|
21928
|
+
* @memberof RolesApiCreateRole
|
|
21929
|
+
*/
|
|
21930
|
+
readonly role: Role;
|
|
21931
|
+
}
|
|
21932
|
+
/**
|
|
21933
|
+
* Request parameters for getRole operation in RolesApi.
|
|
21934
|
+
* @export
|
|
21935
|
+
* @interface RolesApiGetRoleRequest
|
|
21936
|
+
*/
|
|
21937
|
+
export interface RolesApiGetRoleRequest {
|
|
21938
|
+
/**
|
|
21939
|
+
* ID of the Role
|
|
21940
|
+
* @type {string}
|
|
21941
|
+
* @memberof RolesApiGetRole
|
|
21942
|
+
*/
|
|
21943
|
+
readonly id: string;
|
|
21944
|
+
}
|
|
21945
|
+
/**
|
|
21946
|
+
* Request parameters for getRoleAssignedIdentities operation in RolesApi.
|
|
21947
|
+
* @export
|
|
21948
|
+
* @interface RolesApiGetRoleAssignedIdentitiesRequest
|
|
21949
|
+
*/
|
|
21950
|
+
export interface RolesApiGetRoleAssignedIdentitiesRequest {
|
|
21951
|
+
/**
|
|
21952
|
+
* ID of the Role for which the assigned Identities are to be listed
|
|
21953
|
+
* @type {string}
|
|
21954
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21955
|
+
*/
|
|
21956
|
+
readonly id: string;
|
|
21957
|
+
/**
|
|
21958
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21959
|
+
* @type {number}
|
|
21960
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21961
|
+
*/
|
|
21962
|
+
readonly limit?: number;
|
|
21963
|
+
/**
|
|
21964
|
+
* 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.
|
|
21965
|
+
* @type {number}
|
|
21966
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21967
|
+
*/
|
|
21968
|
+
readonly offset?: number;
|
|
21969
|
+
/**
|
|
21970
|
+
* 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.
|
|
21971
|
+
* @type {boolean}
|
|
21972
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21973
|
+
*/
|
|
21974
|
+
readonly count?: boolean;
|
|
21975
|
+
/**
|
|
21976
|
+
* 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co*
|
|
21977
|
+
* @type {string}
|
|
21978
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21979
|
+
*/
|
|
21980
|
+
readonly filters?: string;
|
|
21981
|
+
/**
|
|
21982
|
+
* 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**, **aliasName**, **email**
|
|
21983
|
+
* @type {string}
|
|
21984
|
+
* @memberof RolesApiGetRoleAssignedIdentities
|
|
21985
|
+
*/
|
|
21986
|
+
readonly sorters?: string;
|
|
21987
|
+
}
|
|
21988
|
+
/**
|
|
21989
|
+
* Request parameters for listRoles operation in RolesApi.
|
|
21990
|
+
* @export
|
|
21991
|
+
* @interface RolesApiListRolesRequest
|
|
21992
|
+
*/
|
|
21993
|
+
export interface RolesApiListRolesRequest {
|
|
21994
|
+
/**
|
|
21995
|
+
* If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
21996
|
+
* @type {string}
|
|
21997
|
+
* @memberof RolesApiListRoles
|
|
21998
|
+
*/
|
|
21999
|
+
readonly forSubadmin?: string;
|
|
22000
|
+
/**
|
|
22001
|
+
* Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22002
|
+
* @type {number}
|
|
22003
|
+
* @memberof RolesApiListRoles
|
|
22004
|
+
*/
|
|
22005
|
+
readonly limit?: number;
|
|
22006
|
+
/**
|
|
22007
|
+
* 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.
|
|
22008
|
+
* @type {number}
|
|
22009
|
+
* @memberof RolesApiListRoles
|
|
22010
|
+
*/
|
|
22011
|
+
readonly offset?: number;
|
|
22012
|
+
/**
|
|
22013
|
+
* 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.
|
|
22014
|
+
* @type {boolean}
|
|
22015
|
+
* @memberof RolesApiListRoles
|
|
22016
|
+
*/
|
|
22017
|
+
readonly count?: boolean;
|
|
22018
|
+
/**
|
|
22019
|
+
* 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* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*
|
|
22020
|
+
* @type {string}
|
|
22021
|
+
* @memberof RolesApiListRoles
|
|
22022
|
+
*/
|
|
22023
|
+
readonly filters?: string;
|
|
22024
|
+
/**
|
|
22025
|
+
* 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**
|
|
22026
|
+
* @type {string}
|
|
22027
|
+
* @memberof RolesApiListRoles
|
|
22028
|
+
*/
|
|
22029
|
+
readonly sorters?: string;
|
|
22030
|
+
/**
|
|
22031
|
+
* If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
22032
|
+
* @type {string}
|
|
22033
|
+
* @memberof RolesApiListRoles
|
|
22034
|
+
*/
|
|
22035
|
+
readonly forSegmentIds?: string;
|
|
22036
|
+
/**
|
|
22037
|
+
* Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
22038
|
+
* @type {boolean}
|
|
22039
|
+
* @memberof RolesApiListRoles
|
|
22040
|
+
*/
|
|
22041
|
+
readonly includeUnsegmented?: boolean;
|
|
22042
|
+
}
|
|
22043
|
+
/**
|
|
22044
|
+
* Request parameters for patchRole operation in RolesApi.
|
|
22045
|
+
* @export
|
|
22046
|
+
* @interface RolesApiPatchRoleRequest
|
|
22047
|
+
*/
|
|
22048
|
+
export interface RolesApiPatchRoleRequest {
|
|
22049
|
+
/**
|
|
22050
|
+
* ID of the Role to patch
|
|
22051
|
+
* @type {string}
|
|
22052
|
+
* @memberof RolesApiPatchRole
|
|
22053
|
+
*/
|
|
22054
|
+
readonly id: string;
|
|
22055
|
+
/**
|
|
22056
|
+
*
|
|
22057
|
+
* @type {Array<JsonPatchOperation>}
|
|
22058
|
+
* @memberof RolesApiPatchRole
|
|
22059
|
+
*/
|
|
22060
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
22061
|
+
}
|
|
22062
|
+
/**
|
|
22063
|
+
* RolesApi - object-oriented interface
|
|
22064
|
+
* @export
|
|
22065
|
+
* @class RolesApi
|
|
22066
|
+
* @extends {BaseAPI}
|
|
22067
|
+
*/
|
|
22068
|
+
export declare class RolesApi extends BaseAPI {
|
|
22069
|
+
/**
|
|
22070
|
+
* This API creates a Role. There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
22071
|
+
* @summary Create a Role
|
|
22072
|
+
* @param {RolesApiCreateRoleRequest} requestParameters Request parameters.
|
|
22073
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
22074
|
+
* @throws {RequiredError}
|
|
22075
|
+
* @memberof RolesApi
|
|
22076
|
+
*/
|
|
22077
|
+
createRole(requestParameters: RolesApiCreateRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Role, any>>;
|
|
22078
|
+
/**
|
|
22079
|
+
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
22080
|
+
* @summary Get a Role
|
|
22081
|
+
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
22082
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
22083
|
+
* @throws {RequiredError}
|
|
22084
|
+
* @memberof RolesApi
|
|
22085
|
+
*/
|
|
22086
|
+
getRole(requestParameters: RolesApiGetRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Role, any>>;
|
|
22087
|
+
/**
|
|
22088
|
+
*
|
|
22089
|
+
* @summary List Identities assigned a Role
|
|
22090
|
+
* @param {RolesApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters.
|
|
22091
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
22092
|
+
* @throws {RequiredError}
|
|
22093
|
+
* @memberof RolesApi
|
|
22094
|
+
*/
|
|
22095
|
+
getRoleAssignedIdentities(requestParameters: RolesApiGetRoleAssignedIdentitiesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleIdentity[], any>>;
|
|
22096
|
+
/**
|
|
22097
|
+
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
22098
|
+
* @summary List Roles
|
|
22099
|
+
* @param {RolesApiListRolesRequest} requestParameters Request parameters.
|
|
22100
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
22101
|
+
* @throws {RequiredError}
|
|
22102
|
+
* @memberof RolesApi
|
|
22103
|
+
*/
|
|
22104
|
+
listRoles(requestParameters?: RolesApiListRolesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Role[], any>>;
|
|
22105
|
+
/**
|
|
22106
|
+
* This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
22107
|
+
* @summary Patch a specified Role
|
|
22108
|
+
* @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
|
|
22109
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
22110
|
+
* @throws {RequiredError}
|
|
22111
|
+
* @memberof RolesApi
|
|
22112
|
+
*/
|
|
22113
|
+
patchRole(requestParameters: RolesApiPatchRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Role, any>>;
|
|
22114
|
+
}
|
|
19780
22115
|
/**
|
|
19781
22116
|
* SavedSearchApi - axios parameter creator
|
|
19782
22117
|
* @export
|
|
@@ -21447,7 +23782,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
21447
23782
|
*/
|
|
21448
23783
|
updateSource: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21449
23784
|
/**
|
|
21450
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
23785
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
21451
23786
|
* @summary Update Source Schema (Partial)
|
|
21452
23787
|
* @param {string} sourceId The Source id.
|
|
21453
23788
|
* @param {string} schemaId The Schema id.
|
|
@@ -21682,7 +24017,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
21682
24017
|
*/
|
|
21683
24018
|
updateSource(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Source>>;
|
|
21684
24019
|
/**
|
|
21685
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24020
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
21686
24021
|
* @summary Update Source Schema (Partial)
|
|
21687
24022
|
* @param {string} sourceId The Source id.
|
|
21688
24023
|
* @param {string} schemaId The Schema id.
|
|
@@ -21917,7 +24252,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
21917
24252
|
*/
|
|
21918
24253
|
updateSource(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<Source>;
|
|
21919
24254
|
/**
|
|
21920
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24255
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
21921
24256
|
* @summary Update Source Schema (Partial)
|
|
21922
24257
|
* @param {string} sourceId The Source id.
|
|
21923
24258
|
* @param {string} schemaId The Schema id.
|
|
@@ -22651,7 +24986,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
22651
24986
|
*/
|
|
22652
24987
|
updateSource(requestParameters: SourcesApiUpdateSourceRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Source, any>>;
|
|
22653
24988
|
/**
|
|
22654
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24989
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
22655
24990
|
* @summary Update Source Schema (Partial)
|
|
22656
24991
|
* @param {SourcesApiUpdateSourceSchemaRequest} requestParameters Request parameters.
|
|
22657
24992
|
* @param {*} [axiosOptions] Override http request option.
|