sailpoint-api-client 1.1.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/api.ts +15616 -11604
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/cc/README.md +2 -2
- package/cc/api.ts +142 -80
- package/cc/common.ts +2 -2
- package/cc/package.json +1 -1
- package/configuration.ts +2 -0
- package/dist/beta/api.d.ts +6426 -3885
- package/dist/beta/api.js +9199 -6014
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/base.js +4 -1
- package/dist/beta/base.js.map +1 -1
- package/dist/beta/common.js +7 -4
- package/dist/beta/common.js.map +1 -1
- package/dist/cc/api.d.ts +71 -9
- package/dist/cc/api.js +134 -131
- package/dist/cc/api.js.map +1 -1
- package/dist/cc/base.js +4 -1
- package/dist/cc/base.js.map +1 -1
- package/dist/cc/common.js +7 -4
- package/dist/cc/common.js.map +1 -1
- package/dist/configuration.js +33 -6
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +14 -1
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +8 -8
- package/dist/index.spec.js.map +1 -1
- package/dist/paginator.d.ts +5 -2
- package/dist/paginator.js +1 -1
- package/dist/paginator.js.map +1 -1
- package/dist/v2/api.d.ts +4 -4
- package/dist/v2/api.js +68 -65
- package/dist/v2/api.js.map +1 -1
- package/dist/v2/base.js +4 -1
- package/dist/v2/base.js.map +1 -1
- package/dist/v2/common.js +7 -4
- package/dist/v2/common.js.map +1 -1
- package/dist/v3/api.d.ts +1630 -279
- package/dist/v3/api.js +3722 -1743
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/base.js +4 -1
- package/dist/v3/base.js.map +1 -1
- package/dist/v3/common.js +7 -4
- package/dist/v3/common.js.map +1 -1
- package/index.spec.ts +7 -7
- package/index.ts +2 -1
- package/package.json +1 -1
- package/paginator.ts +5 -1
- package/tsconfig.json +1 -0
- package/v2/README.md +2 -2
- package/v2/api.ts +36 -36
- package/v2/common.ts +2 -2
- package/v2/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +3256 -1000
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -98,12 +98,12 @@ export declare const AccessConstraintTypeEnum: {
|
|
|
98
98
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
99
99
|
readonly Role: "ROLE";
|
|
100
100
|
};
|
|
101
|
-
export
|
|
101
|
+
export type AccessConstraintTypeEnum = typeof AccessConstraintTypeEnum[keyof typeof AccessConstraintTypeEnum];
|
|
102
102
|
export declare const AccessConstraintOperatorEnum: {
|
|
103
103
|
readonly All: "ALL";
|
|
104
104
|
readonly Selected: "SELECTED";
|
|
105
105
|
};
|
|
106
|
-
export
|
|
106
|
+
export type AccessConstraintOperatorEnum = typeof AccessConstraintOperatorEnum[keyof typeof AccessConstraintOperatorEnum];
|
|
107
107
|
/**
|
|
108
108
|
*
|
|
109
109
|
* @export
|
|
@@ -151,7 +151,7 @@ export interface AccessCriteriaCriteriaListInner {
|
|
|
151
151
|
export declare const AccessCriteriaCriteriaListInnerTypeEnum: {
|
|
152
152
|
readonly Entitlement: "ENTITLEMENT";
|
|
153
153
|
};
|
|
154
|
-
export
|
|
154
|
+
export type AccessCriteriaCriteriaListInnerTypeEnum = typeof AccessCriteriaCriteriaListInnerTypeEnum[keyof typeof AccessCriteriaCriteriaListInnerTypeEnum];
|
|
155
155
|
/**
|
|
156
156
|
*
|
|
157
157
|
* @export
|
|
@@ -269,7 +269,7 @@ export declare const AccessProfileApprovalSchemeApproverTypeEnum: {
|
|
|
269
269
|
readonly Manager: "MANAGER";
|
|
270
270
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
271
271
|
};
|
|
272
|
-
export
|
|
272
|
+
export type AccessProfileApprovalSchemeApproverTypeEnum = typeof AccessProfileApprovalSchemeApproverTypeEnum[keyof typeof AccessProfileApprovalSchemeApproverTypeEnum];
|
|
273
273
|
/**
|
|
274
274
|
*
|
|
275
275
|
* @export
|
|
@@ -537,7 +537,7 @@ export interface AccessProfileRef {
|
|
|
537
537
|
export declare const AccessProfileRefTypeEnum: {
|
|
538
538
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
539
539
|
};
|
|
540
|
-
export
|
|
540
|
+
export type AccessProfileRefTypeEnum = typeof AccessProfileRefTypeEnum[keyof typeof AccessProfileRefTypeEnum];
|
|
541
541
|
/**
|
|
542
542
|
* Role
|
|
543
543
|
* @export
|
|
@@ -621,7 +621,7 @@ export interface AccessProfileSourceRef {
|
|
|
621
621
|
export declare const AccessProfileSourceRefTypeEnum: {
|
|
622
622
|
readonly Source: "SOURCE";
|
|
623
623
|
};
|
|
624
|
-
export
|
|
624
|
+
export type AccessProfileSourceRefTypeEnum = typeof AccessProfileSourceRefTypeEnum[keyof typeof AccessProfileSourceRefTypeEnum];
|
|
625
625
|
/**
|
|
626
626
|
* This is a summary representation of an access profile.
|
|
627
627
|
* @export
|
|
@@ -824,7 +824,7 @@ export interface AccessRequestItem {
|
|
|
824
824
|
[key: string]: string;
|
|
825
825
|
};
|
|
826
826
|
/**
|
|
827
|
-
* 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.
|
|
827
|
+
* 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.
|
|
828
828
|
* @type {string}
|
|
829
829
|
* @memberof AccessRequestItem
|
|
830
830
|
*/
|
|
@@ -835,7 +835,7 @@ export declare const AccessRequestItemTypeEnum: {
|
|
|
835
835
|
readonly Role: "ROLE";
|
|
836
836
|
readonly Entitlement: "ENTITLEMENT";
|
|
837
837
|
};
|
|
838
|
-
export
|
|
838
|
+
export type AccessRequestItemTypeEnum = typeof AccessRequestItemTypeEnum[keyof typeof AccessRequestItemTypeEnum];
|
|
839
839
|
/**
|
|
840
840
|
* Provides additional details about this access request phase.
|
|
841
841
|
* @export
|
|
@@ -885,12 +885,12 @@ export declare const AccessRequestPhasesStateEnum: {
|
|
|
885
885
|
readonly Completed: "COMPLETED";
|
|
886
886
|
readonly Cancelled: "CANCELLED";
|
|
887
887
|
};
|
|
888
|
-
export
|
|
888
|
+
export type AccessRequestPhasesStateEnum = typeof AccessRequestPhasesStateEnum[keyof typeof AccessRequestPhasesStateEnum];
|
|
889
889
|
export declare const AccessRequestPhasesResultEnum: {
|
|
890
890
|
readonly Successful: "SUCCESSFUL";
|
|
891
891
|
readonly Failed: "FAILED";
|
|
892
892
|
};
|
|
893
|
-
export
|
|
893
|
+
export type AccessRequestPhasesResultEnum = typeof AccessRequestPhasesResultEnum[keyof typeof AccessRequestPhasesResultEnum];
|
|
894
894
|
/**
|
|
895
895
|
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
896
896
|
* @export
|
|
@@ -900,7 +900,7 @@ export declare const AccessRequestType: {
|
|
|
900
900
|
readonly GrantAccess: "GRANT_ACCESS";
|
|
901
901
|
readonly RevokeAccess: "REVOKE_ACCESS";
|
|
902
902
|
};
|
|
903
|
-
export
|
|
903
|
+
export type AccessRequestType = typeof AccessRequestType[keyof typeof AccessRequestType];
|
|
904
904
|
/**
|
|
905
905
|
*
|
|
906
906
|
* @export
|
|
@@ -1040,7 +1040,7 @@ export declare const AccessType: {
|
|
|
1040
1040
|
readonly Online: "ONLINE";
|
|
1041
1041
|
readonly Offline: "OFFLINE";
|
|
1042
1042
|
};
|
|
1043
|
-
export
|
|
1043
|
+
export type AccessType = typeof AccessType[keyof typeof AccessType];
|
|
1044
1044
|
/**
|
|
1045
1045
|
*
|
|
1046
1046
|
* @export
|
|
@@ -1181,7 +1181,7 @@ export declare const AccountActionActionEnum: {
|
|
|
1181
1181
|
readonly Enable: "ENABLE";
|
|
1182
1182
|
readonly Disable: "DISABLE";
|
|
1183
1183
|
};
|
|
1184
|
-
export
|
|
1184
|
+
export type AccountActionActionEnum = typeof AccountActionActionEnum[keyof typeof AccountActionActionEnum];
|
|
1185
1185
|
/**
|
|
1186
1186
|
*
|
|
1187
1187
|
* @export
|
|
@@ -1517,7 +1517,7 @@ export declare const AccountActivityItemOperation: {
|
|
|
1517
1517
|
readonly Lock: "LOCK";
|
|
1518
1518
|
readonly Remove: "REMOVE";
|
|
1519
1519
|
};
|
|
1520
|
-
export
|
|
1520
|
+
export type AccountActivityItemOperation = typeof AccountActivityItemOperation[keyof typeof AccountActivityItemOperation];
|
|
1521
1521
|
/**
|
|
1522
1522
|
* AccountActivity
|
|
1523
1523
|
* @export
|
|
@@ -2304,6 +2304,19 @@ export interface AccountsAsyncResult {
|
|
|
2304
2304
|
*/
|
|
2305
2305
|
'id': string;
|
|
2306
2306
|
}
|
|
2307
|
+
/**
|
|
2308
|
+
*
|
|
2309
|
+
* @export
|
|
2310
|
+
* @interface ActivateCampaignOptions
|
|
2311
|
+
*/
|
|
2312
|
+
export interface ActivateCampaignOptions {
|
|
2313
|
+
/**
|
|
2314
|
+
* The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.
|
|
2315
|
+
* @type {string}
|
|
2316
|
+
* @memberof ActivateCampaignOptions
|
|
2317
|
+
*/
|
|
2318
|
+
'timeZone'?: string;
|
|
2319
|
+
}
|
|
2307
2320
|
/**
|
|
2308
2321
|
*
|
|
2309
2322
|
* @export
|
|
@@ -2351,7 +2364,7 @@ export interface AdminReviewReassignReassignTo {
|
|
|
2351
2364
|
export declare const AdminReviewReassignReassignToTypeEnum: {
|
|
2352
2365
|
readonly Identity: "IDENTITY";
|
|
2353
2366
|
};
|
|
2354
|
-
export
|
|
2367
|
+
export type AdminReviewReassignReassignToTypeEnum = typeof AdminReviewReassignReassignToTypeEnum[keyof typeof AdminReviewReassignReassignToTypeEnum];
|
|
2355
2368
|
/**
|
|
2356
2369
|
* Aggregation
|
|
2357
2370
|
* @export
|
|
@@ -2563,7 +2576,7 @@ export declare const AggregationType: {
|
|
|
2563
2576
|
readonly Dsl: "DSL";
|
|
2564
2577
|
readonly Sailpoint: "SAILPOINT";
|
|
2565
2578
|
};
|
|
2566
|
-
export
|
|
2579
|
+
export type AggregationType = typeof AggregationType[keyof typeof AggregationType];
|
|
2567
2580
|
/**
|
|
2568
2581
|
*
|
|
2569
2582
|
* @export
|
|
@@ -2782,7 +2795,7 @@ export interface ApprovalForwardHistory {
|
|
|
2782
2795
|
*/
|
|
2783
2796
|
export interface ApprovalItemDetails {
|
|
2784
2797
|
/**
|
|
2785
|
-
*
|
|
2798
|
+
* The approval item\'s ID
|
|
2786
2799
|
* @type {string}
|
|
2787
2800
|
* @memberof ApprovalItemDetails
|
|
2788
2801
|
*/
|
|
@@ -2794,29 +2807,29 @@ export interface ApprovalItemDetails {
|
|
|
2794
2807
|
*/
|
|
2795
2808
|
'account'?: string;
|
|
2796
2809
|
/**
|
|
2797
|
-
* The name the application/source
|
|
2810
|
+
* The name of the application/source
|
|
2798
2811
|
* @type {string}
|
|
2799
2812
|
* @memberof ApprovalItemDetails
|
|
2800
2813
|
*/
|
|
2801
2814
|
'application'?: string;
|
|
2802
2815
|
/**
|
|
2803
|
-
* The name
|
|
2816
|
+
* The attribute\'s name
|
|
2804
2817
|
* @type {string}
|
|
2805
2818
|
* @memberof ApprovalItemDetails
|
|
2806
2819
|
*/
|
|
2807
|
-
'
|
|
2820
|
+
'name'?: string;
|
|
2808
2821
|
/**
|
|
2809
|
-
* The operation
|
|
2822
|
+
* The attribute\'s operation
|
|
2810
2823
|
* @type {string}
|
|
2811
2824
|
* @memberof ApprovalItemDetails
|
|
2812
2825
|
*/
|
|
2813
|
-
'
|
|
2826
|
+
'operation'?: string;
|
|
2814
2827
|
/**
|
|
2815
|
-
* The value
|
|
2828
|
+
* The attribute\'s value
|
|
2816
2829
|
* @type {string}
|
|
2817
2830
|
* @memberof ApprovalItemDetails
|
|
2818
2831
|
*/
|
|
2819
|
-
'
|
|
2832
|
+
'value'?: string;
|
|
2820
2833
|
/**
|
|
2821
2834
|
*
|
|
2822
2835
|
* @type {WorkItemState}
|
|
@@ -2831,7 +2844,7 @@ export interface ApprovalItemDetails {
|
|
|
2831
2844
|
*/
|
|
2832
2845
|
export interface ApprovalItems {
|
|
2833
2846
|
/**
|
|
2834
|
-
*
|
|
2847
|
+
* The approval item\'s ID
|
|
2835
2848
|
* @type {string}
|
|
2836
2849
|
* @memberof ApprovalItems
|
|
2837
2850
|
*/
|
|
@@ -2843,29 +2856,29 @@ export interface ApprovalItems {
|
|
|
2843
2856
|
*/
|
|
2844
2857
|
'account'?: string;
|
|
2845
2858
|
/**
|
|
2846
|
-
* The name the application/source
|
|
2859
|
+
* The name of the application/source
|
|
2847
2860
|
* @type {string}
|
|
2848
2861
|
* @memberof ApprovalItems
|
|
2849
2862
|
*/
|
|
2850
2863
|
'application'?: string;
|
|
2851
2864
|
/**
|
|
2852
|
-
* The name
|
|
2865
|
+
* The attribute\'s name
|
|
2853
2866
|
* @type {string}
|
|
2854
2867
|
* @memberof ApprovalItems
|
|
2855
2868
|
*/
|
|
2856
|
-
'
|
|
2869
|
+
'name'?: string;
|
|
2857
2870
|
/**
|
|
2858
|
-
* The operation
|
|
2871
|
+
* The attribute\'s operation
|
|
2859
2872
|
* @type {string}
|
|
2860
2873
|
* @memberof ApprovalItems
|
|
2861
2874
|
*/
|
|
2862
|
-
'
|
|
2875
|
+
'operation'?: string;
|
|
2863
2876
|
/**
|
|
2864
|
-
* The value
|
|
2877
|
+
* The attribute\'s value
|
|
2865
2878
|
* @type {string}
|
|
2866
2879
|
* @memberof ApprovalItems
|
|
2867
2880
|
*/
|
|
2868
|
-
'
|
|
2881
|
+
'value'?: string;
|
|
2869
2882
|
/**
|
|
2870
2883
|
*
|
|
2871
2884
|
* @type {WorkItemState}
|
|
@@ -2918,7 +2931,7 @@ export declare const ApprovalScheme: {
|
|
|
2918
2931
|
readonly EntitlementOwner: "ENTITLEMENT_OWNER";
|
|
2919
2932
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2920
2933
|
};
|
|
2921
|
-
export
|
|
2934
|
+
export type ApprovalScheme = typeof ApprovalScheme[keyof typeof ApprovalScheme];
|
|
2922
2935
|
/**
|
|
2923
2936
|
*
|
|
2924
2937
|
* @export
|
|
@@ -2943,7 +2956,7 @@ export declare const ApprovalSchemeForRoleApproverTypeEnum: {
|
|
|
2943
2956
|
readonly Manager: "MANAGER";
|
|
2944
2957
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2945
2958
|
};
|
|
2946
|
-
export
|
|
2959
|
+
export type ApprovalSchemeForRoleApproverTypeEnum = typeof ApprovalSchemeForRoleApproverTypeEnum[keyof typeof ApprovalSchemeForRoleApproverTypeEnum];
|
|
2947
2960
|
/**
|
|
2948
2961
|
* Enum representing the non-employee request approval status
|
|
2949
2962
|
* @export
|
|
@@ -2956,7 +2969,7 @@ export declare const ApprovalStatus: {
|
|
|
2956
2969
|
readonly NotReady: "NOT_READY";
|
|
2957
2970
|
readonly Cancelled: "CANCELLED";
|
|
2958
2971
|
};
|
|
2959
|
-
export
|
|
2972
|
+
export type ApprovalStatus = typeof ApprovalStatus[keyof typeof ApprovalStatus];
|
|
2960
2973
|
/**
|
|
2961
2974
|
*
|
|
2962
2975
|
* @export
|
|
@@ -3126,7 +3139,7 @@ export interface AttributeDefinitionSchema {
|
|
|
3126
3139
|
export declare const AttributeDefinitionSchemaTypeEnum: {
|
|
3127
3140
|
readonly ConnectorSchema: "CONNECTOR_SCHEMA";
|
|
3128
3141
|
};
|
|
3129
|
-
export
|
|
3142
|
+
export type AttributeDefinitionSchemaTypeEnum = typeof AttributeDefinitionSchemaTypeEnum[keyof typeof AttributeDefinitionSchemaTypeEnum];
|
|
3130
3143
|
/**
|
|
3131
3144
|
* The underlying type of the value which an AttributeDefinition represents.
|
|
3132
3145
|
* @export
|
|
@@ -3138,7 +3151,7 @@ export declare const AttributeDefinitionType: {
|
|
|
3138
3151
|
readonly Int: "INT";
|
|
3139
3152
|
readonly Boolean: "BOOLEAN";
|
|
3140
3153
|
};
|
|
3141
|
-
export
|
|
3154
|
+
export type AttributeDefinitionType = typeof AttributeDefinitionType[keyof typeof AttributeDefinitionType];
|
|
3142
3155
|
/**
|
|
3143
3156
|
*
|
|
3144
3157
|
* @export
|
|
@@ -3164,6 +3177,115 @@ export interface AttributeRequest {
|
|
|
3164
3177
|
*/
|
|
3165
3178
|
'value'?: string;
|
|
3166
3179
|
}
|
|
3180
|
+
/**
|
|
3181
|
+
*
|
|
3182
|
+
* @export
|
|
3183
|
+
* @interface AuthUser
|
|
3184
|
+
*/
|
|
3185
|
+
export interface AuthUser {
|
|
3186
|
+
/**
|
|
3187
|
+
* Tenant name.
|
|
3188
|
+
* @type {string}
|
|
3189
|
+
* @memberof AuthUser
|
|
3190
|
+
*/
|
|
3191
|
+
'tenant'?: string;
|
|
3192
|
+
/**
|
|
3193
|
+
* Identity ID.
|
|
3194
|
+
* @type {string}
|
|
3195
|
+
* @memberof AuthUser
|
|
3196
|
+
*/
|
|
3197
|
+
'id'?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* Identity unique identitifier.
|
|
3200
|
+
* @type {string}
|
|
3201
|
+
* @memberof AuthUser
|
|
3202
|
+
*/
|
|
3203
|
+
'uid'?: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* ID of the auth profile associated with this auth user.
|
|
3206
|
+
* @type {string}
|
|
3207
|
+
* @memberof AuthUser
|
|
3208
|
+
*/
|
|
3209
|
+
'profile'?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* Auth user employee number.
|
|
3212
|
+
* @type {string}
|
|
3213
|
+
* @memberof AuthUser
|
|
3214
|
+
*/
|
|
3215
|
+
'identificationNumber'?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Auth user\'s email.
|
|
3218
|
+
* @type {string}
|
|
3219
|
+
* @memberof AuthUser
|
|
3220
|
+
*/
|
|
3221
|
+
'email'?: string;
|
|
3222
|
+
/**
|
|
3223
|
+
* Auth user\'s phone number.
|
|
3224
|
+
* @type {string}
|
|
3225
|
+
* @memberof AuthUser
|
|
3226
|
+
*/
|
|
3227
|
+
'phone'?: string;
|
|
3228
|
+
/**
|
|
3229
|
+
* Auth user\'s work phone number.
|
|
3230
|
+
* @type {string}
|
|
3231
|
+
* @memberof AuthUser
|
|
3232
|
+
*/
|
|
3233
|
+
'workPhone'?: string;
|
|
3234
|
+
/**
|
|
3235
|
+
* Auth user\'s personal email.
|
|
3236
|
+
* @type {string}
|
|
3237
|
+
* @memberof AuthUser
|
|
3238
|
+
*/
|
|
3239
|
+
'personalEmail'?: string;
|
|
3240
|
+
/**
|
|
3241
|
+
* Auth user\'s first name.
|
|
3242
|
+
* @type {string}
|
|
3243
|
+
* @memberof AuthUser
|
|
3244
|
+
*/
|
|
3245
|
+
'firstname'?: string;
|
|
3246
|
+
/**
|
|
3247
|
+
* Auth user\'s last name.
|
|
3248
|
+
* @type {string}
|
|
3249
|
+
* @memberof AuthUser
|
|
3250
|
+
*/
|
|
3251
|
+
'lastname'?: string;
|
|
3252
|
+
/**
|
|
3253
|
+
* Auth user\'s name in displayed format.
|
|
3254
|
+
* @type {string}
|
|
3255
|
+
* @memberof AuthUser
|
|
3256
|
+
*/
|
|
3257
|
+
'displayName'?: string;
|
|
3258
|
+
/**
|
|
3259
|
+
* Auth user\'s alias.
|
|
3260
|
+
* @type {string}
|
|
3261
|
+
* @memberof AuthUser
|
|
3262
|
+
*/
|
|
3263
|
+
'alias'?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* the date of last password change
|
|
3266
|
+
* @type {string}
|
|
3267
|
+
* @memberof AuthUser
|
|
3268
|
+
*/
|
|
3269
|
+
'lastPasswordChangeDate'?: string;
|
|
3270
|
+
/**
|
|
3271
|
+
* Timestamp of the last login (long type value).
|
|
3272
|
+
* @type {number}
|
|
3273
|
+
* @memberof AuthUser
|
|
3274
|
+
*/
|
|
3275
|
+
'lastLoginTimestamp'?: number;
|
|
3276
|
+
/**
|
|
3277
|
+
* Timestamp of the current login (long type value).
|
|
3278
|
+
* @type {number}
|
|
3279
|
+
* @memberof AuthUser
|
|
3280
|
+
*/
|
|
3281
|
+
'currentLoginTimestamp'?: number;
|
|
3282
|
+
/**
|
|
3283
|
+
* Array of capabilities for this auth user.
|
|
3284
|
+
* @type {Array<string>}
|
|
3285
|
+
* @memberof AuthUser
|
|
3286
|
+
*/
|
|
3287
|
+
'capabilities'?: Array<string>;
|
|
3288
|
+
}
|
|
3167
3289
|
/**
|
|
3168
3290
|
*
|
|
3169
3291
|
* @export
|
|
@@ -3673,7 +3795,7 @@ export interface BucketAggregation {
|
|
|
3673
3795
|
export declare const BucketType: {
|
|
3674
3796
|
readonly Terms: "TERMS";
|
|
3675
3797
|
};
|
|
3676
|
-
export
|
|
3798
|
+
export type BucketType = typeof BucketType[keyof typeof BucketType];
|
|
3677
3799
|
/**
|
|
3678
3800
|
*
|
|
3679
3801
|
* @export
|
|
@@ -3703,7 +3825,7 @@ export declare const BulkTaggedObjectOperationEnum: {
|
|
|
3703
3825
|
readonly Append: "APPEND";
|
|
3704
3826
|
readonly Merge: "MERGE";
|
|
3705
3827
|
};
|
|
3706
|
-
export
|
|
3828
|
+
export type BulkTaggedObjectOperationEnum = typeof BulkTaggedObjectOperationEnum[keyof typeof BulkTaggedObjectOperationEnum];
|
|
3707
3829
|
/**
|
|
3708
3830
|
*
|
|
3709
3831
|
* @export
|
|
@@ -3729,7 +3851,7 @@ export interface Campaign {
|
|
|
3729
3851
|
*/
|
|
3730
3852
|
'description': string;
|
|
3731
3853
|
/**
|
|
3732
|
-
* The campaign\'s completion deadline.
|
|
3854
|
+
* The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.
|
|
3733
3855
|
* @type {string}
|
|
3734
3856
|
* @memberof Campaign
|
|
3735
3857
|
*/
|
|
@@ -3849,7 +3971,7 @@ export declare const CampaignTypeEnum: {
|
|
|
3849
3971
|
readonly Search: "SEARCH";
|
|
3850
3972
|
readonly RoleComposition: "ROLE_COMPOSITION";
|
|
3851
3973
|
};
|
|
3852
|
-
export
|
|
3974
|
+
export type CampaignTypeEnum = typeof CampaignTypeEnum[keyof typeof CampaignTypeEnum];
|
|
3853
3975
|
export declare const CampaignStatusEnum: {
|
|
3854
3976
|
readonly Pending: "PENDING";
|
|
3855
3977
|
readonly Staged: "STAGED";
|
|
@@ -3861,18 +3983,18 @@ export declare const CampaignStatusEnum: {
|
|
|
3861
3983
|
readonly Error: "ERROR";
|
|
3862
3984
|
readonly Archived: "ARCHIVED";
|
|
3863
3985
|
};
|
|
3864
|
-
export
|
|
3986
|
+
export type CampaignStatusEnum = typeof CampaignStatusEnum[keyof typeof CampaignStatusEnum];
|
|
3865
3987
|
export declare const CampaignCorrelatedStatusEnum: {
|
|
3866
3988
|
readonly Correlated: "CORRELATED";
|
|
3867
3989
|
readonly Uncorrelated: "UNCORRELATED";
|
|
3868
3990
|
};
|
|
3869
|
-
export
|
|
3991
|
+
export type CampaignCorrelatedStatusEnum = typeof CampaignCorrelatedStatusEnum[keyof typeof CampaignCorrelatedStatusEnum];
|
|
3870
3992
|
export declare const CampaignMandatoryCommentRequirementEnum: {
|
|
3871
3993
|
readonly AllDecisions: "ALL_DECISIONS";
|
|
3872
3994
|
readonly RevokeOnlyDecisions: "REVOKE_ONLY_DECISIONS";
|
|
3873
3995
|
readonly NoDecisions: "NO_DECISIONS";
|
|
3874
3996
|
};
|
|
3875
|
-
export
|
|
3997
|
+
export type CampaignMandatoryCommentRequirementEnum = typeof CampaignMandatoryCommentRequirementEnum[keyof typeof CampaignMandatoryCommentRequirementEnum];
|
|
3876
3998
|
/**
|
|
3877
3999
|
*
|
|
3878
4000
|
* @export
|
|
@@ -3897,7 +4019,7 @@ export declare const CampaignAlertLevelEnum: {
|
|
|
3897
4019
|
readonly Warn: "WARN";
|
|
3898
4020
|
readonly Info: "INFO";
|
|
3899
4021
|
};
|
|
3900
|
-
export
|
|
4022
|
+
export type CampaignAlertLevelEnum = typeof CampaignAlertLevelEnum[keyof typeof CampaignAlertLevelEnum];
|
|
3901
4023
|
/**
|
|
3902
4024
|
*
|
|
3903
4025
|
* @export
|
|
@@ -3987,13 +4109,13 @@ export declare const CampaignAllOfCorrelatedStatusEnum: {
|
|
|
3987
4109
|
readonly Correlated: "CORRELATED";
|
|
3988
4110
|
readonly Uncorrelated: "UNCORRELATED";
|
|
3989
4111
|
};
|
|
3990
|
-
export
|
|
4112
|
+
export type CampaignAllOfCorrelatedStatusEnum = typeof CampaignAllOfCorrelatedStatusEnum[keyof typeof CampaignAllOfCorrelatedStatusEnum];
|
|
3991
4113
|
export declare const CampaignAllOfMandatoryCommentRequirementEnum: {
|
|
3992
4114
|
readonly AllDecisions: "ALL_DECISIONS";
|
|
3993
4115
|
readonly RevokeOnlyDecisions: "REVOKE_ONLY_DECISIONS";
|
|
3994
4116
|
readonly NoDecisions: "NO_DECISIONS";
|
|
3995
4117
|
};
|
|
3996
|
-
export
|
|
4118
|
+
export type CampaignAllOfMandatoryCommentRequirementEnum = typeof CampaignAllOfMandatoryCommentRequirementEnum[keyof typeof CampaignAllOfMandatoryCommentRequirementEnum];
|
|
3997
4119
|
/**
|
|
3998
4120
|
* Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
|
|
3999
4121
|
* @export
|
|
@@ -4023,7 +4145,7 @@ export declare const CampaignAllOfFilterTypeEnum: {
|
|
|
4023
4145
|
readonly CampaignFilter: "CAMPAIGN_FILTER";
|
|
4024
4146
|
readonly Rule: "RULE";
|
|
4025
4147
|
};
|
|
4026
|
-
export
|
|
4148
|
+
export type CampaignAllOfFilterTypeEnum = typeof CampaignAllOfFilterTypeEnum[keyof typeof CampaignAllOfFilterTypeEnum];
|
|
4027
4149
|
/**
|
|
4028
4150
|
* Optional configuration options for role composition campaigns.
|
|
4029
4151
|
* @export
|
|
@@ -4089,7 +4211,7 @@ export interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRef {
|
|
|
4089
4211
|
export declare const CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeEnum: {
|
|
4090
4212
|
readonly Identity: "IDENTITY";
|
|
4091
4213
|
};
|
|
4092
|
-
export
|
|
4214
|
+
export type CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeEnum = typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeEnum[keyof typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeEnum];
|
|
4093
4215
|
/**
|
|
4094
4216
|
* Must be set only if the campaign type is SEARCH.
|
|
4095
4217
|
* @export
|
|
@@ -4137,7 +4259,7 @@ export declare const CampaignAllOfSearchCampaignInfoTypeEnum: {
|
|
|
4137
4259
|
readonly Identity: "IDENTITY";
|
|
4138
4260
|
readonly Access: "ACCESS";
|
|
4139
4261
|
};
|
|
4140
|
-
export
|
|
4262
|
+
export type CampaignAllOfSearchCampaignInfoTypeEnum = typeof CampaignAllOfSearchCampaignInfoTypeEnum[keyof typeof CampaignAllOfSearchCampaignInfoTypeEnum];
|
|
4141
4263
|
/**
|
|
4142
4264
|
* Must be set only if the campaign type is SOURCE_OWNER.
|
|
4143
4265
|
* @export
|
|
@@ -4179,7 +4301,25 @@ export interface CampaignAllOfSourcesWithOrphanEntitlements {
|
|
|
4179
4301
|
export declare const CampaignAllOfSourcesWithOrphanEntitlementsTypeEnum: {
|
|
4180
4302
|
readonly Source: "SOURCE";
|
|
4181
4303
|
};
|
|
4182
|
-
export
|
|
4304
|
+
export type CampaignAllOfSourcesWithOrphanEntitlementsTypeEnum = typeof CampaignAllOfSourcesWithOrphanEntitlementsTypeEnum[keyof typeof CampaignAllOfSourcesWithOrphanEntitlementsTypeEnum];
|
|
4305
|
+
/**
|
|
4306
|
+
*
|
|
4307
|
+
* @export
|
|
4308
|
+
* @interface CampaignCompleteOptions
|
|
4309
|
+
*/
|
|
4310
|
+
export interface CampaignCompleteOptions {
|
|
4311
|
+
/**
|
|
4312
|
+
* Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion.
|
|
4313
|
+
* @type {string}
|
|
4314
|
+
* @memberof CampaignCompleteOptions
|
|
4315
|
+
*/
|
|
4316
|
+
'autoCompleteAction'?: CampaignCompleteOptionsAutoCompleteActionEnum;
|
|
4317
|
+
}
|
|
4318
|
+
export declare const CampaignCompleteOptionsAutoCompleteActionEnum: {
|
|
4319
|
+
readonly Approve: "APPROVE";
|
|
4320
|
+
readonly Revoke: "REVOKE";
|
|
4321
|
+
};
|
|
4322
|
+
export type CampaignCompleteOptionsAutoCompleteActionEnum = typeof CampaignCompleteOptionsAutoCompleteActionEnum[keyof typeof CampaignCompleteOptionsAutoCompleteActionEnum];
|
|
4183
4323
|
/**
|
|
4184
4324
|
*
|
|
4185
4325
|
* @export
|
|
@@ -4232,24 +4372,121 @@ export interface CampaignReference {
|
|
|
4232
4372
|
export declare const CampaignReferenceTypeEnum: {
|
|
4233
4373
|
readonly Campaign: "CAMPAIGN";
|
|
4234
4374
|
};
|
|
4235
|
-
export
|
|
4375
|
+
export type CampaignReferenceTypeEnum = typeof CampaignReferenceTypeEnum[keyof typeof CampaignReferenceTypeEnum];
|
|
4236
4376
|
export declare const CampaignReferenceCampaignTypeEnum: {
|
|
4237
4377
|
readonly Manager: "MANAGER";
|
|
4238
4378
|
readonly SourceOwner: "SOURCE_OWNER";
|
|
4239
4379
|
readonly Search: "SEARCH";
|
|
4240
4380
|
};
|
|
4241
|
-
export
|
|
4381
|
+
export type CampaignReferenceCampaignTypeEnum = typeof CampaignReferenceCampaignTypeEnum[keyof typeof CampaignReferenceCampaignTypeEnum];
|
|
4242
4382
|
export declare const CampaignReferenceCorrelatedStatusEnum: {
|
|
4243
4383
|
readonly Correlated: "CORRELATED";
|
|
4244
4384
|
readonly Uncorrelated: "UNCORRELATED";
|
|
4245
4385
|
};
|
|
4246
|
-
export
|
|
4386
|
+
export type CampaignReferenceCorrelatedStatusEnum = typeof CampaignReferenceCorrelatedStatusEnum[keyof typeof CampaignReferenceCorrelatedStatusEnum];
|
|
4247
4387
|
export declare const CampaignReferenceMandatoryCommentRequirementEnum: {
|
|
4248
4388
|
readonly AllDecisions: "ALL_DECISIONS";
|
|
4249
4389
|
readonly RevokeOnlyDecisions: "REVOKE_ONLY_DECISIONS";
|
|
4250
4390
|
readonly NoDecisions: "NO_DECISIONS";
|
|
4251
4391
|
};
|
|
4252
|
-
export
|
|
4392
|
+
export type CampaignReferenceMandatoryCommentRequirementEnum = typeof CampaignReferenceMandatoryCommentRequirementEnum[keyof typeof CampaignReferenceMandatoryCommentRequirementEnum];
|
|
4393
|
+
/**
|
|
4394
|
+
*
|
|
4395
|
+
* @export
|
|
4396
|
+
* @interface CampaignReport
|
|
4397
|
+
*/
|
|
4398
|
+
export interface CampaignReport {
|
|
4399
|
+
/**
|
|
4400
|
+
*
|
|
4401
|
+
* @type {DtoType}
|
|
4402
|
+
* @memberof CampaignReport
|
|
4403
|
+
*/
|
|
4404
|
+
'type'?: DtoType;
|
|
4405
|
+
/**
|
|
4406
|
+
* ID of the object to which this reference applies
|
|
4407
|
+
* @type {string}
|
|
4408
|
+
* @memberof CampaignReport
|
|
4409
|
+
*/
|
|
4410
|
+
'id'?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* Human-readable display name of the object to which this reference applies
|
|
4413
|
+
* @type {string}
|
|
4414
|
+
* @memberof CampaignReport
|
|
4415
|
+
*/
|
|
4416
|
+
'name'?: string;
|
|
4417
|
+
/**
|
|
4418
|
+
* Status of a violation report
|
|
4419
|
+
* @type {string}
|
|
4420
|
+
* @memberof CampaignReport
|
|
4421
|
+
*/
|
|
4422
|
+
'status'?: CampaignReportStatusEnum;
|
|
4423
|
+
/**
|
|
4424
|
+
*
|
|
4425
|
+
* @type {ReportType}
|
|
4426
|
+
* @memberof CampaignReport
|
|
4427
|
+
*/
|
|
4428
|
+
'reportType': ReportType;
|
|
4429
|
+
/**
|
|
4430
|
+
* The most recent date and time this report was run
|
|
4431
|
+
* @type {string}
|
|
4432
|
+
* @memberof CampaignReport
|
|
4433
|
+
*/
|
|
4434
|
+
'lastRunAt'?: string;
|
|
4435
|
+
}
|
|
4436
|
+
export declare const CampaignReportStatusEnum: {
|
|
4437
|
+
readonly Success: "SUCCESS";
|
|
4438
|
+
readonly Warning: "WARNING";
|
|
4439
|
+
readonly Error: "ERROR";
|
|
4440
|
+
readonly Terminated: "TERMINATED";
|
|
4441
|
+
readonly TempError: "TEMP_ERROR";
|
|
4442
|
+
readonly Pending: "PENDING";
|
|
4443
|
+
};
|
|
4444
|
+
export type CampaignReportStatusEnum = typeof CampaignReportStatusEnum[keyof typeof CampaignReportStatusEnum];
|
|
4445
|
+
/**
|
|
4446
|
+
*
|
|
4447
|
+
* @export
|
|
4448
|
+
* @interface CampaignReportAllOf
|
|
4449
|
+
*/
|
|
4450
|
+
export interface CampaignReportAllOf {
|
|
4451
|
+
/**
|
|
4452
|
+
*
|
|
4453
|
+
* @type {ReportType}
|
|
4454
|
+
* @memberof CampaignReportAllOf
|
|
4455
|
+
*/
|
|
4456
|
+
'reportType'?: ReportType;
|
|
4457
|
+
/**
|
|
4458
|
+
* The most recent date and time this report was run
|
|
4459
|
+
* @type {string}
|
|
4460
|
+
* @memberof CampaignReportAllOf
|
|
4461
|
+
*/
|
|
4462
|
+
'lastRunAt'?: string;
|
|
4463
|
+
}
|
|
4464
|
+
/**
|
|
4465
|
+
*
|
|
4466
|
+
* @export
|
|
4467
|
+
* @interface CampaignReportsConfig
|
|
4468
|
+
*/
|
|
4469
|
+
export interface CampaignReportsConfig {
|
|
4470
|
+
/**
|
|
4471
|
+
* list of identity attribute columns
|
|
4472
|
+
* @type {Array<string>}
|
|
4473
|
+
* @memberof CampaignReportsConfig
|
|
4474
|
+
*/
|
|
4475
|
+
'identityAttributeColumns'?: Array<string>;
|
|
4476
|
+
}
|
|
4477
|
+
/**
|
|
4478
|
+
*
|
|
4479
|
+
* @export
|
|
4480
|
+
* @interface CampaignsDeleteRequest
|
|
4481
|
+
*/
|
|
4482
|
+
export interface CampaignsDeleteRequest {
|
|
4483
|
+
/**
|
|
4484
|
+
* The ids of the campaigns to delete
|
|
4485
|
+
* @type {Array<string>}
|
|
4486
|
+
* @memberof CampaignsDeleteRequest
|
|
4487
|
+
*/
|
|
4488
|
+
'ids'?: Array<string>;
|
|
4489
|
+
}
|
|
4253
4490
|
/**
|
|
4254
4491
|
* Request body payload for cancel access request endpoint.
|
|
4255
4492
|
* @export
|
|
@@ -4257,7 +4494,7 @@ export declare type CampaignReferenceMandatoryCommentRequirementEnum = typeof Ca
|
|
|
4257
4494
|
*/
|
|
4258
4495
|
export interface CancelAccessRequest {
|
|
4259
4496
|
/**
|
|
4260
|
-
*
|
|
4497
|
+
* This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId.
|
|
4261
4498
|
* @type {string}
|
|
4262
4499
|
* @memberof CancelAccessRequest
|
|
4263
4500
|
*/
|
|
@@ -4412,7 +4649,7 @@ export declare const CertificationDecision: {
|
|
|
4412
4649
|
readonly Approve: "APPROVE";
|
|
4413
4650
|
readonly Revoke: "REVOKE";
|
|
4414
4651
|
};
|
|
4415
|
-
export
|
|
4652
|
+
export type CertificationDecision = typeof CertificationDecision[keyof typeof CertificationDecision];
|
|
4416
4653
|
/**
|
|
4417
4654
|
*
|
|
4418
4655
|
* @export
|
|
@@ -4454,7 +4691,7 @@ export declare const CertificationPhase: {
|
|
|
4454
4691
|
readonly Active: "ACTIVE";
|
|
4455
4692
|
readonly Signed: "SIGNED";
|
|
4456
4693
|
};
|
|
4457
|
-
export
|
|
4694
|
+
export type CertificationPhase = typeof CertificationPhase[keyof typeof CertificationPhase];
|
|
4458
4695
|
/**
|
|
4459
4696
|
*
|
|
4460
4697
|
* @export
|
|
@@ -4489,7 +4726,7 @@ export interface CertificationReference {
|
|
|
4489
4726
|
export declare const CertificationReferenceTypeEnum: {
|
|
4490
4727
|
readonly Certification: "CERTIFICATION";
|
|
4491
4728
|
};
|
|
4492
|
-
export
|
|
4729
|
+
export type CertificationReferenceTypeEnum = typeof CertificationReferenceTypeEnum[keyof typeof CertificationReferenceTypeEnum];
|
|
4493
4730
|
/**
|
|
4494
4731
|
*
|
|
4495
4732
|
* @export
|
|
@@ -4555,19 +4792,19 @@ export declare const CertificationTaskTypeEnum: {
|
|
|
4555
4792
|
readonly CampaignCreate: "CAMPAIGN_CREATE";
|
|
4556
4793
|
readonly CampaignDelete: "CAMPAIGN_DELETE";
|
|
4557
4794
|
};
|
|
4558
|
-
export
|
|
4795
|
+
export type CertificationTaskTypeEnum = typeof CertificationTaskTypeEnum[keyof typeof CertificationTaskTypeEnum];
|
|
4559
4796
|
export declare const CertificationTaskTargetTypeEnum: {
|
|
4560
4797
|
readonly Certification: "CERTIFICATION";
|
|
4561
4798
|
readonly Campaign: "CAMPAIGN";
|
|
4562
4799
|
};
|
|
4563
|
-
export
|
|
4800
|
+
export type CertificationTaskTargetTypeEnum = typeof CertificationTaskTargetTypeEnum[keyof typeof CertificationTaskTargetTypeEnum];
|
|
4564
4801
|
export declare const CertificationTaskStatusEnum: {
|
|
4565
4802
|
readonly Queued: "QUEUED";
|
|
4566
4803
|
readonly InProgress: "IN_PROGRESS";
|
|
4567
4804
|
readonly Success: "SUCCESS";
|
|
4568
4805
|
readonly Error: "ERROR";
|
|
4569
4806
|
};
|
|
4570
|
-
export
|
|
4807
|
+
export type CertificationTaskStatusEnum = typeof CertificationTaskStatusEnum[keyof typeof CertificationTaskStatusEnum];
|
|
4571
4808
|
/**
|
|
4572
4809
|
* Type of an API Client indicating public or confidentials use
|
|
4573
4810
|
* @export
|
|
@@ -4577,7 +4814,7 @@ export declare const ClientType: {
|
|
|
4577
4814
|
readonly Confidential: "CONFIDENTIAL";
|
|
4578
4815
|
readonly Public: "PUBLIC";
|
|
4579
4816
|
};
|
|
4580
|
-
export
|
|
4817
|
+
export type ClientType = typeof ClientType[keyof typeof ClientType];
|
|
4581
4818
|
/**
|
|
4582
4819
|
*
|
|
4583
4820
|
* @export
|
|
@@ -4845,7 +5082,7 @@ export declare const CompletedApprovalState: {
|
|
|
4845
5082
|
readonly Approved: "APPROVED";
|
|
4846
5083
|
readonly Rejected: "REJECTED";
|
|
4847
5084
|
};
|
|
4848
|
-
export
|
|
5085
|
+
export type CompletedApprovalState = typeof CompletedApprovalState[keyof typeof CompletedApprovalState];
|
|
4849
5086
|
/**
|
|
4850
5087
|
* The status after completion.
|
|
4851
5088
|
* @export
|
|
@@ -4857,7 +5094,7 @@ export declare const CompletionStatus: {
|
|
|
4857
5094
|
readonly Incomplete: "INCOMPLETE";
|
|
4858
5095
|
readonly Pending: "PENDING";
|
|
4859
5096
|
};
|
|
4860
|
-
export
|
|
5097
|
+
export type CompletionStatus = typeof CompletionStatus[keyof typeof CompletionStatus];
|
|
4861
5098
|
/**
|
|
4862
5099
|
*
|
|
4863
5100
|
* @export
|
|
@@ -5422,19 +5659,19 @@ export declare const DateCompareOperatorEnum: {
|
|
|
5422
5659
|
readonly Gt: "GT";
|
|
5423
5660
|
readonly Gte: "GTE";
|
|
5424
5661
|
};
|
|
5425
|
-
export
|
|
5662
|
+
export type DateCompareOperatorEnum = typeof DateCompareOperatorEnum[keyof typeof DateCompareOperatorEnum];
|
|
5426
5663
|
/**
|
|
5427
5664
|
* @type DateCompareFirstDate
|
|
5428
5665
|
* This is the first date to consider (The date that would be on the left hand side of the comparison operation).
|
|
5429
5666
|
* @export
|
|
5430
5667
|
*/
|
|
5431
|
-
export
|
|
5668
|
+
export type DateCompareFirstDate = AccountAttribute | DateFormat;
|
|
5432
5669
|
/**
|
|
5433
5670
|
* @type DateCompareSecondDate
|
|
5434
5671
|
* This is the second date to consider (The date that would be on the right hand side of the comparison operation).
|
|
5435
5672
|
* @export
|
|
5436
5673
|
*/
|
|
5437
|
-
export
|
|
5674
|
+
export type DateCompareSecondDate = AccountAttribute | DateFormat;
|
|
5438
5675
|
/**
|
|
5439
5676
|
*
|
|
5440
5677
|
* @export
|
|
@@ -5473,13 +5710,13 @@ export interface DateFormat {
|
|
|
5473
5710
|
* A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format*
|
|
5474
5711
|
* @export
|
|
5475
5712
|
*/
|
|
5476
|
-
export
|
|
5713
|
+
export type DateFormatInputFormat = NamedConstructs | string;
|
|
5477
5714
|
/**
|
|
5478
5715
|
* @type DateFormatOutputFormat
|
|
5479
5716
|
* A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format*
|
|
5480
5717
|
* @export
|
|
5481
5718
|
*/
|
|
5482
|
-
export
|
|
5719
|
+
export type DateFormatOutputFormat = NamedConstructs | string;
|
|
5483
5720
|
/**
|
|
5484
5721
|
*
|
|
5485
5722
|
* @export
|
|
@@ -5575,7 +5812,7 @@ export interface DeleteSource202Response {
|
|
|
5575
5812
|
export declare const DeleteSource202ResponseTypeEnum: {
|
|
5576
5813
|
readonly TaskResult: "TASK_RESULT";
|
|
5577
5814
|
};
|
|
5578
|
-
export
|
|
5815
|
+
export type DeleteSource202ResponseTypeEnum = typeof DeleteSource202ResponseTypeEnum[keyof typeof DeleteSource202ResponseTypeEnum];
|
|
5579
5816
|
/**
|
|
5580
5817
|
*
|
|
5581
5818
|
* @export
|
|
@@ -5629,7 +5866,7 @@ export declare const DocumentType: {
|
|
|
5629
5866
|
readonly Identity: "identity";
|
|
5630
5867
|
readonly Role: "role";
|
|
5631
5868
|
};
|
|
5632
|
-
export
|
|
5869
|
+
export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
|
|
5633
5870
|
/**
|
|
5634
5871
|
* An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
|
|
5635
5872
|
* @export
|
|
@@ -5663,8 +5900,9 @@ export declare const DtoType: {
|
|
|
5663
5900
|
readonly ReportResult: "REPORT_RESULT";
|
|
5664
5901
|
readonly SodViolation: "SOD_VIOLATION";
|
|
5665
5902
|
readonly AccountActivity: "ACCOUNT_ACTIVITY";
|
|
5903
|
+
readonly Workgroup: "WORKGROUP";
|
|
5666
5904
|
};
|
|
5667
|
-
export
|
|
5905
|
+
export type DtoType = typeof DtoType[keyof typeof DtoType];
|
|
5668
5906
|
/**
|
|
5669
5907
|
*
|
|
5670
5908
|
* @export
|
|
@@ -6116,7 +6354,7 @@ export interface EntitlementRef {
|
|
|
6116
6354
|
export declare const EntitlementRefTypeEnum: {
|
|
6117
6355
|
readonly Entitlement: "ENTITLEMENT";
|
|
6118
6356
|
};
|
|
6119
|
-
export
|
|
6357
|
+
export type EntitlementRefTypeEnum = typeof EntitlementRefTypeEnum[keyof typeof EntitlementRefTypeEnum];
|
|
6120
6358
|
/**
|
|
6121
6359
|
*
|
|
6122
6360
|
* @export
|
|
@@ -6763,7 +7001,7 @@ export interface ExceptionCriteriaCriteriaListInner {
|
|
|
6763
7001
|
export declare const ExceptionCriteriaCriteriaListInnerTypeEnum: {
|
|
6764
7002
|
readonly Entitlement: "ENTITLEMENT";
|
|
6765
7003
|
};
|
|
6766
|
-
export
|
|
7004
|
+
export type ExceptionCriteriaCriteriaListInnerTypeEnum = typeof ExceptionCriteriaCriteriaListInnerTypeEnum[keyof typeof ExceptionCriteriaCriteriaListInnerTypeEnum];
|
|
6767
7005
|
/**
|
|
6768
7006
|
* The current state of execution.
|
|
6769
7007
|
* @export
|
|
@@ -6775,7 +7013,7 @@ export declare const ExecutionStatus: {
|
|
|
6775
7013
|
readonly Terminated: "TERMINATED";
|
|
6776
7014
|
readonly Completed: "COMPLETED";
|
|
6777
7015
|
};
|
|
6778
|
-
export
|
|
7016
|
+
export type ExecutionStatus = typeof ExecutionStatus[keyof typeof ExecutionStatus];
|
|
6779
7017
|
/**
|
|
6780
7018
|
*
|
|
6781
7019
|
* @export
|
|
@@ -6848,7 +7086,7 @@ export declare const ExpressionOperatorEnum: {
|
|
|
6848
7086
|
readonly And: "AND";
|
|
6849
7087
|
readonly Equals: "EQUALS";
|
|
6850
7088
|
};
|
|
6851
|
-
export
|
|
7089
|
+
export type ExpressionOperatorEnum = typeof ExpressionOperatorEnum[keyof typeof ExpressionOperatorEnum];
|
|
6852
7090
|
/**
|
|
6853
7091
|
*
|
|
6854
7092
|
* @export
|
|
@@ -6964,7 +7202,7 @@ export declare const FilterType: {
|
|
|
6964
7202
|
readonly Range: "RANGE";
|
|
6965
7203
|
readonly Terms: "TERMS";
|
|
6966
7204
|
};
|
|
6967
|
-
export
|
|
7205
|
+
export type FilterType = typeof FilterType[keyof typeof FilterType];
|
|
6968
7206
|
/**
|
|
6969
7207
|
*
|
|
6970
7208
|
* @export
|
|
@@ -7131,7 +7369,7 @@ export interface GenericRule {
|
|
|
7131
7369
|
* @type GetActiveCampaigns200ResponseInner
|
|
7132
7370
|
* @export
|
|
7133
7371
|
*/
|
|
7134
|
-
export
|
|
7372
|
+
export type GetActiveCampaigns200ResponseInner = Campaign | SlimCampaign;
|
|
7135
7373
|
/**
|
|
7136
7374
|
*
|
|
7137
7375
|
* @export
|
|
@@ -7337,7 +7575,7 @@ export declare const GrantType: {
|
|
|
7337
7575
|
readonly AuthorizationCode: "AUTHORIZATION_CODE";
|
|
7338
7576
|
readonly RefreshToken: "REFRESH_TOKEN";
|
|
7339
7577
|
};
|
|
7340
|
-
export
|
|
7578
|
+
export type GrantType = typeof GrantType[keyof typeof GrantType];
|
|
7341
7579
|
/**
|
|
7342
7580
|
*
|
|
7343
7581
|
* @export
|
|
@@ -7369,7 +7607,7 @@ export interface ISO3166 {
|
|
|
7369
7607
|
* @type IdentityAccess
|
|
7370
7608
|
* @export
|
|
7371
7609
|
*/
|
|
7372
|
-
export
|
|
7610
|
+
export type IdentityAccess = AccessProfileEntitlement | AccessProfileRole | AccessProfileSummary;
|
|
7373
7611
|
/**
|
|
7374
7612
|
*
|
|
7375
7613
|
* @export
|
|
@@ -8261,7 +8499,7 @@ export interface IdentityProfileAllOfAuthoritativeSource {
|
|
|
8261
8499
|
export declare const IdentityProfileAllOfAuthoritativeSourceTypeEnum: {
|
|
8262
8500
|
readonly Source: "SOURCE";
|
|
8263
8501
|
};
|
|
8264
|
-
export
|
|
8502
|
+
export type IdentityProfileAllOfAuthoritativeSourceTypeEnum = typeof IdentityProfileAllOfAuthoritativeSourceTypeEnum[keyof typeof IdentityProfileAllOfAuthoritativeSourceTypeEnum];
|
|
8265
8503
|
/**
|
|
8266
8504
|
* The owner of the Identity Profile.
|
|
8267
8505
|
* @export
|
|
@@ -8290,7 +8528,7 @@ export interface IdentityProfileAllOfOwner {
|
|
|
8290
8528
|
export declare const IdentityProfileAllOfOwnerTypeEnum: {
|
|
8291
8529
|
readonly Identity: "IDENTITY";
|
|
8292
8530
|
};
|
|
8293
|
-
export
|
|
8531
|
+
export type IdentityProfileAllOfOwnerTypeEnum = typeof IdentityProfileAllOfOwnerTypeEnum[keyof typeof IdentityProfileAllOfOwnerTypeEnum];
|
|
8294
8532
|
/**
|
|
8295
8533
|
* Identity Profile exported object
|
|
8296
8534
|
* @export
|
|
@@ -8477,7 +8715,7 @@ export interface IdentityWithNewAccessAccessRefsInner {
|
|
|
8477
8715
|
export declare const IdentityWithNewAccessAccessRefsInnerTypeEnum: {
|
|
8478
8716
|
readonly Entitlement: "ENTITLEMENT";
|
|
8479
8717
|
};
|
|
8480
|
-
export
|
|
8718
|
+
export type IdentityWithNewAccessAccessRefsInnerTypeEnum = typeof IdentityWithNewAccessAccessRefsInnerTypeEnum[keyof typeof IdentityWithNewAccessAccessRefsInnerTypeEnum];
|
|
8481
8719
|
/**
|
|
8482
8720
|
*
|
|
8483
8721
|
* @export
|
|
@@ -8505,7 +8743,7 @@ export declare const Index: {
|
|
|
8505
8743
|
readonly Roles: "roles";
|
|
8506
8744
|
readonly Star: "*";
|
|
8507
8745
|
};
|
|
8508
|
-
export
|
|
8746
|
+
export type Index = typeof Index[keyof typeof Index];
|
|
8509
8747
|
/**
|
|
8510
8748
|
*
|
|
8511
8749
|
* @export
|
|
@@ -8598,7 +8836,7 @@ export declare const JsonPatchOperationOpEnum: {
|
|
|
8598
8836
|
readonly Copy: "copy";
|
|
8599
8837
|
readonly Test: "test";
|
|
8600
8838
|
};
|
|
8601
|
-
export
|
|
8839
|
+
export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum];
|
|
8602
8840
|
/**
|
|
8603
8841
|
* The value to be used for the operation, required for \"add\" and \"replace\" operations
|
|
8604
8842
|
* @export
|
|
@@ -8803,7 +9041,7 @@ export declare const LocaleOrigin: {
|
|
|
8803
9041
|
readonly Default: "DEFAULT";
|
|
8804
9042
|
readonly Request: "REQUEST";
|
|
8805
9043
|
};
|
|
8806
|
-
export
|
|
9044
|
+
export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
|
|
8807
9045
|
/**
|
|
8808
9046
|
*
|
|
8809
9047
|
* @export
|
|
@@ -8929,7 +9167,7 @@ export declare const ManualWorkItemState: {
|
|
|
8929
9167
|
readonly Cancelled: "CANCELLED";
|
|
8930
9168
|
readonly Archived: "ARCHIVED";
|
|
8931
9169
|
};
|
|
8932
|
-
export
|
|
9170
|
+
export type ManualWorkItemState = typeof ManualWorkItemState[keyof typeof ManualWorkItemState];
|
|
8933
9171
|
/**
|
|
8934
9172
|
* The calculation done on the results of the query
|
|
8935
9173
|
* @export
|
|
@@ -8969,7 +9207,7 @@ export declare const MetricType: {
|
|
|
8969
9207
|
readonly Min: "MIN";
|
|
8970
9208
|
readonly Max: "MAX";
|
|
8971
9209
|
};
|
|
8972
|
-
export
|
|
9210
|
+
export type MetricType = typeof MetricType[keyof typeof MetricType];
|
|
8973
9211
|
/**
|
|
8974
9212
|
*
|
|
8975
9213
|
* @export
|
|
@@ -9035,7 +9273,7 @@ export declare const NamedConstructs: {
|
|
|
9035
9273
|
readonly EpochTimeJava: "EPOCH_TIME_JAVA";
|
|
9036
9274
|
readonly EpochTimeWin32: "EPOCH_TIME_WIN32";
|
|
9037
9275
|
};
|
|
9038
|
-
export
|
|
9276
|
+
export type NamedConstructs = typeof NamedConstructs[keyof typeof NamedConstructs];
|
|
9039
9277
|
/**
|
|
9040
9278
|
* The nested aggregation object.
|
|
9041
9279
|
* @export
|
|
@@ -9055,6 +9293,31 @@ export interface NestedAggregation {
|
|
|
9055
9293
|
*/
|
|
9056
9294
|
'type': string;
|
|
9057
9295
|
}
|
|
9296
|
+
/**
|
|
9297
|
+
*
|
|
9298
|
+
* @export
|
|
9299
|
+
* @interface NetworkConfiguration
|
|
9300
|
+
*/
|
|
9301
|
+
export interface NetworkConfiguration {
|
|
9302
|
+
/**
|
|
9303
|
+
* The collection of ip ranges.
|
|
9304
|
+
* @type {Array<string>}
|
|
9305
|
+
* @memberof NetworkConfiguration
|
|
9306
|
+
*/
|
|
9307
|
+
'range'?: Array<string>;
|
|
9308
|
+
/**
|
|
9309
|
+
* The collection of country codes.
|
|
9310
|
+
* @type {Array<string>}
|
|
9311
|
+
* @memberof NetworkConfiguration
|
|
9312
|
+
*/
|
|
9313
|
+
'geolocation'?: Array<string>;
|
|
9314
|
+
/**
|
|
9315
|
+
* Denotes whether the provided lists are whitelisted or blacklisted for geo location.
|
|
9316
|
+
* @type {boolean}
|
|
9317
|
+
* @memberof NetworkConfiguration
|
|
9318
|
+
*/
|
|
9319
|
+
'whitelisted'?: boolean;
|
|
9320
|
+
}
|
|
9058
9321
|
/**
|
|
9059
9322
|
*
|
|
9060
9323
|
* @export
|
|
@@ -9339,7 +9602,7 @@ export declare const NonEmployeeBulkUploadJobStatusEnum: {
|
|
|
9339
9602
|
readonly Completed: "COMPLETED";
|
|
9340
9603
|
readonly Error: "ERROR";
|
|
9341
9604
|
};
|
|
9342
|
-
export
|
|
9605
|
+
export type NonEmployeeBulkUploadJobStatusEnum = typeof NonEmployeeBulkUploadJobStatusEnum[keyof typeof NonEmployeeBulkUploadJobStatusEnum];
|
|
9343
9606
|
/**
|
|
9344
9607
|
*
|
|
9345
9608
|
* @export
|
|
@@ -9359,7 +9622,7 @@ export declare const NonEmployeeBulkUploadStatusStatusEnum: {
|
|
|
9359
9622
|
readonly Completed: "COMPLETED";
|
|
9360
9623
|
readonly Error: "ERROR";
|
|
9361
9624
|
};
|
|
9362
|
-
export
|
|
9625
|
+
export type NonEmployeeBulkUploadStatusStatusEnum = typeof NonEmployeeBulkUploadStatusStatusEnum[keyof typeof NonEmployeeBulkUploadStatusStatusEnum];
|
|
9363
9626
|
/**
|
|
9364
9627
|
* Identifies if the identity is a normal identity or a governance group
|
|
9365
9628
|
* @export
|
|
@@ -9369,7 +9632,7 @@ export declare const NonEmployeeIdentityDtoType: {
|
|
|
9369
9632
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
9370
9633
|
readonly Identity: "IDENTITY";
|
|
9371
9634
|
};
|
|
9372
|
-
export
|
|
9635
|
+
export type NonEmployeeIdentityDtoType = typeof NonEmployeeIdentityDtoType[keyof typeof NonEmployeeIdentityDtoType];
|
|
9373
9636
|
/**
|
|
9374
9637
|
*
|
|
9375
9638
|
* @export
|
|
@@ -10185,7 +10448,7 @@ export declare const NonEmployeeSchemaAttributeType: {
|
|
|
10185
10448
|
readonly Date: "DATE";
|
|
10186
10449
|
readonly Identity: "IDENTITY";
|
|
10187
10450
|
};
|
|
10188
|
-
export
|
|
10451
|
+
export type NonEmployeeSchemaAttributeType = typeof NonEmployeeSchemaAttributeType[keyof typeof NonEmployeeSchemaAttributeType];
|
|
10189
10452
|
/**
|
|
10190
10453
|
*
|
|
10191
10454
|
* @export
|
|
@@ -10785,7 +11048,7 @@ export declare const PasswordChangeResponseStateEnum: {
|
|
|
10785
11048
|
readonly Finished: "FINISHED";
|
|
10786
11049
|
readonly Failed: "FAILED";
|
|
10787
11050
|
};
|
|
10788
|
-
export
|
|
11051
|
+
export type PasswordChangeResponseStateEnum = typeof PasswordChangeResponseStateEnum[keyof typeof PasswordChangeResponseStateEnum];
|
|
10789
11052
|
/**
|
|
10790
11053
|
*
|
|
10791
11054
|
* @export
|
|
@@ -10934,7 +11197,7 @@ export declare const PasswordStatusStateEnum: {
|
|
|
10934
11197
|
readonly Finished: "FINISHED";
|
|
10935
11198
|
readonly Failed: "FAILED";
|
|
10936
11199
|
};
|
|
10937
|
-
export
|
|
11200
|
+
export type PasswordStatusStateEnum = typeof PasswordStatusStateEnum[keyof typeof PasswordStatusStateEnum];
|
|
10938
11201
|
/**
|
|
10939
11202
|
*
|
|
10940
11203
|
* @export
|
|
@@ -11097,7 +11360,7 @@ export declare const PendingApprovalAction: {
|
|
|
11097
11360
|
readonly Rejected: "REJECTED";
|
|
11098
11361
|
readonly Forwarded: "FORWARDED";
|
|
11099
11362
|
};
|
|
11100
|
-
export
|
|
11363
|
+
export type PendingApprovalAction = typeof PendingApprovalAction[keyof typeof PendingApprovalAction];
|
|
11101
11364
|
/**
|
|
11102
11365
|
* 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.
|
|
11103
11366
|
* @export
|
|
@@ -11146,7 +11409,7 @@ export declare const PreApprovalTriggerDetailsDecisionEnum: {
|
|
|
11146
11409
|
readonly Approved: "APPROVED";
|
|
11147
11410
|
readonly Rejected: "REJECTED";
|
|
11148
11411
|
};
|
|
11149
|
-
export
|
|
11412
|
+
export type PreApprovalTriggerDetailsDecisionEnum = typeof PreApprovalTriggerDetailsDecisionEnum[keyof typeof PreApprovalTriggerDetailsDecisionEnum];
|
|
11150
11413
|
/**
|
|
11151
11414
|
*
|
|
11152
11415
|
* @export
|
|
@@ -11249,7 +11512,7 @@ export interface ProvisioningConfigManagedResourceRefsInner {
|
|
|
11249
11512
|
export declare const ProvisioningConfigManagedResourceRefsInnerTypeEnum: {
|
|
11250
11513
|
readonly Source: "SOURCE";
|
|
11251
11514
|
};
|
|
11252
|
-
export
|
|
11515
|
+
export type ProvisioningConfigManagedResourceRefsInnerTypeEnum = typeof ProvisioningConfigManagedResourceRefsInnerTypeEnum[keyof typeof ProvisioningConfigManagedResourceRefsInnerTypeEnum];
|
|
11253
11516
|
/**
|
|
11254
11517
|
* This is a reference to a plan initializer script.
|
|
11255
11518
|
* @export
|
|
@@ -11363,7 +11626,7 @@ export declare const ProvisioningCriteriaOperation: {
|
|
|
11363
11626
|
readonly And: "AND";
|
|
11364
11627
|
readonly Or: "OR";
|
|
11365
11628
|
};
|
|
11366
|
-
export
|
|
11629
|
+
export type ProvisioningCriteriaOperation = typeof ProvisioningCriteriaOperation[keyof typeof ProvisioningCriteriaOperation];
|
|
11367
11630
|
/**
|
|
11368
11631
|
* Provides additional details about provisioning for this request.
|
|
11369
11632
|
* @export
|
|
@@ -11452,7 +11715,7 @@ export declare const ProvisioningState: {
|
|
|
11452
11715
|
readonly Failed: "FAILED";
|
|
11453
11716
|
readonly Retry: "RETRY";
|
|
11454
11717
|
};
|
|
11455
|
-
export
|
|
11718
|
+
export type ProvisioningState = typeof ProvisioningState[keyof typeof ProvisioningState];
|
|
11456
11719
|
/**
|
|
11457
11720
|
* Details about a public identity
|
|
11458
11721
|
* @export
|
|
@@ -11559,7 +11822,7 @@ export interface Query {
|
|
|
11559
11822
|
*/
|
|
11560
11823
|
'query'?: string;
|
|
11561
11824
|
/**
|
|
11562
|
-
* The fields to
|
|
11825
|
+
* The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields.
|
|
11563
11826
|
* @type {Array<string>}
|
|
11564
11827
|
* @memberof Query
|
|
11565
11828
|
*/
|
|
@@ -11604,9 +11867,10 @@ export interface QueryResultFilter {
|
|
|
11604
11867
|
export declare const QueryType: {
|
|
11605
11868
|
readonly Dsl: "DSL";
|
|
11606
11869
|
readonly Sailpoint: "SAILPOINT";
|
|
11870
|
+
readonly Text: "TEXT";
|
|
11607
11871
|
readonly Typeahead: "TYPEAHEAD";
|
|
11608
11872
|
};
|
|
11609
|
-
export
|
|
11873
|
+
export type QueryType = typeof QueryType[keyof typeof QueryType];
|
|
11610
11874
|
/**
|
|
11611
11875
|
* Configuration of maximum number days and interval for checking Service Desk integration queue status
|
|
11612
11876
|
* @export
|
|
@@ -11723,7 +11987,7 @@ export declare const ReassignReferenceTypeEnum: {
|
|
|
11723
11987
|
readonly Item: "ITEM";
|
|
11724
11988
|
readonly IdentitySummary: "IDENTITY_SUMMARY";
|
|
11725
11989
|
};
|
|
11726
|
-
export
|
|
11990
|
+
export type ReassignReferenceTypeEnum = typeof ReassignReferenceTypeEnum[keyof typeof ReassignReferenceTypeEnum];
|
|
11727
11991
|
/**
|
|
11728
11992
|
*
|
|
11729
11993
|
* @export
|
|
@@ -11767,7 +12031,7 @@ export declare const ReassignmentReferenceTypeEnum: {
|
|
|
11767
12031
|
readonly Item: "ITEM";
|
|
11768
12032
|
readonly IdentitySummary: "IDENTITY_SUMMARY";
|
|
11769
12033
|
};
|
|
11770
|
-
export
|
|
12034
|
+
export type ReassignmentReferenceTypeEnum = typeof ReassignmentReferenceTypeEnum[keyof typeof ReassignmentReferenceTypeEnum];
|
|
11771
12035
|
/**
|
|
11772
12036
|
*
|
|
11773
12037
|
* @export
|
|
@@ -11804,7 +12068,7 @@ export declare const ReassignmentType: {
|
|
|
11804
12068
|
readonly AutoEscalation: "AUTO_ESCALATION";
|
|
11805
12069
|
readonly SelfReviewDelegation: "SELF_REVIEW_DELEGATION";
|
|
11806
12070
|
};
|
|
11807
|
-
export
|
|
12071
|
+
export type ReassignmentType = typeof ReassignmentType[keyof typeof ReassignmentType];
|
|
11808
12072
|
/**
|
|
11809
12073
|
*
|
|
11810
12074
|
* @export
|
|
@@ -12074,7 +12338,7 @@ export declare const ReportResultReferenceStatusEnum: {
|
|
|
12074
12338
|
readonly TempError: "TEMP_ERROR";
|
|
12075
12339
|
readonly Pending: "PENDING";
|
|
12076
12340
|
};
|
|
12077
|
-
export
|
|
12341
|
+
export type ReportResultReferenceStatusEnum = typeof ReportResultReferenceStatusEnum[keyof typeof ReportResultReferenceStatusEnum];
|
|
12078
12342
|
/**
|
|
12079
12343
|
*
|
|
12080
12344
|
* @export
|
|
@@ -12096,7 +12360,19 @@ export declare const ReportResultReferenceAllOfStatusEnum: {
|
|
|
12096
12360
|
readonly TempError: "TEMP_ERROR";
|
|
12097
12361
|
readonly Pending: "PENDING";
|
|
12098
12362
|
};
|
|
12099
|
-
export
|
|
12363
|
+
export type ReportResultReferenceAllOfStatusEnum = typeof ReportResultReferenceAllOfStatusEnum[keyof typeof ReportResultReferenceAllOfStatusEnum];
|
|
12364
|
+
/**
|
|
12365
|
+
* type of a Report
|
|
12366
|
+
* @export
|
|
12367
|
+
* @enum {string}
|
|
12368
|
+
*/
|
|
12369
|
+
export declare const ReportType: {
|
|
12370
|
+
readonly CampaignCompositionReport: "CAMPAIGN_COMPOSITION_REPORT";
|
|
12371
|
+
readonly CampaignRemediationStatusReport: "CAMPAIGN_REMEDIATION_STATUS_REPORT";
|
|
12372
|
+
readonly CampaignStatusReport: "CAMPAIGN_STATUS_REPORT";
|
|
12373
|
+
readonly CertificationSignoffReport: "CERTIFICATION_SIGNOFF_REPORT";
|
|
12374
|
+
};
|
|
12375
|
+
export type ReportType = typeof ReportType[keyof typeof ReportType];
|
|
12100
12376
|
/**
|
|
12101
12377
|
*
|
|
12102
12378
|
* @export
|
|
@@ -12269,7 +12545,7 @@ export declare const RequestableObjectReferenceTypeEnum: {
|
|
|
12269
12545
|
readonly Role: "ROLE";
|
|
12270
12546
|
readonly Entitlement: "ENTITLEMENT";
|
|
12271
12547
|
};
|
|
12272
|
-
export
|
|
12548
|
+
export type RequestableObjectReferenceTypeEnum = typeof RequestableObjectReferenceTypeEnum[keyof typeof RequestableObjectReferenceTypeEnum];
|
|
12273
12549
|
/**
|
|
12274
12550
|
* Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.
|
|
12275
12551
|
* @export
|
|
@@ -12280,18 +12556,17 @@ export declare const RequestableObjectRequestStatus: {
|
|
|
12280
12556
|
readonly Pending: "PENDING";
|
|
12281
12557
|
readonly Assigned: "ASSIGNED";
|
|
12282
12558
|
};
|
|
12283
|
-
export
|
|
12559
|
+
export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStatus[keyof typeof RequestableObjectRequestStatus];
|
|
12284
12560
|
/**
|
|
12285
|
-
*
|
|
12561
|
+
* The currently supported requestable object types.
|
|
12286
12562
|
* @export
|
|
12287
12563
|
* @enum {string}
|
|
12288
12564
|
*/
|
|
12289
12565
|
export declare const RequestableObjectType: {
|
|
12290
12566
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
12291
12567
|
readonly Role: "ROLE";
|
|
12292
|
-
readonly Entitlement: "ENTITLEMENT";
|
|
12293
12568
|
};
|
|
12294
|
-
export
|
|
12569
|
+
export type RequestableObjectType = typeof RequestableObjectType[keyof typeof RequestableObjectType];
|
|
12295
12570
|
/**
|
|
12296
12571
|
*
|
|
12297
12572
|
* @export
|
|
@@ -12444,7 +12719,7 @@ export declare const RequestedItemStatusTypeEnum: {
|
|
|
12444
12719
|
readonly Role: "ROLE";
|
|
12445
12720
|
readonly Entitlement: "ENTITLEMENT";
|
|
12446
12721
|
};
|
|
12447
|
-
export
|
|
12722
|
+
export type RequestedItemStatusTypeEnum = typeof RequestedItemStatusTypeEnum[keyof typeof RequestedItemStatusTypeEnum];
|
|
12448
12723
|
/**
|
|
12449
12724
|
* Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing.
|
|
12450
12725
|
* @export
|
|
@@ -12461,7 +12736,7 @@ export declare const RequestedItemStatusRequestState: {
|
|
|
12461
12736
|
readonly NotAllItemsProvisioned: "NOT_ALL_ITEMS_PROVISIONED";
|
|
12462
12737
|
readonly Error: "ERROR";
|
|
12463
12738
|
};
|
|
12464
|
-
export
|
|
12739
|
+
export type RequestedItemStatusRequestState = typeof RequestedItemStatusRequestState[keyof typeof RequestedItemStatusRequestState];
|
|
12465
12740
|
/**
|
|
12466
12741
|
*
|
|
12467
12742
|
* @export
|
|
@@ -12875,7 +13150,7 @@ export interface Reviewer {
|
|
|
12875
13150
|
export declare const ReviewerTypeEnum: {
|
|
12876
13151
|
readonly Identity: "IDENTITY";
|
|
12877
13152
|
};
|
|
12878
|
-
export
|
|
13153
|
+
export type ReviewerTypeEnum = typeof ReviewerTypeEnum[keyof typeof ReviewerTypeEnum];
|
|
12879
13154
|
/**
|
|
12880
13155
|
*
|
|
12881
13156
|
* @export
|
|
@@ -13036,7 +13311,7 @@ export declare const RoleAssignmentSourceType: {
|
|
|
13036
13311
|
readonly AccessRequest: "ACCESS_REQUEST";
|
|
13037
13312
|
readonly RoleMembership: "ROLE_MEMBERSHIP";
|
|
13038
13313
|
};
|
|
13039
|
-
export
|
|
13314
|
+
export type RoleAssignmentSourceType = typeof RoleAssignmentSourceType[keyof typeof RoleAssignmentSourceType];
|
|
13040
13315
|
/**
|
|
13041
13316
|
* Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
|
|
13042
13317
|
* @export
|
|
@@ -13072,7 +13347,7 @@ export declare const RoleCriteriaKeyType: {
|
|
|
13072
13347
|
readonly Account: "ACCOUNT";
|
|
13073
13348
|
readonly Entitlement: "ENTITLEMENT";
|
|
13074
13349
|
};
|
|
13075
|
-
export
|
|
13350
|
+
export type RoleCriteriaKeyType = typeof RoleCriteriaKeyType[keyof typeof RoleCriteriaKeyType];
|
|
13076
13351
|
/**
|
|
13077
13352
|
* Defines STANDARD type Role membership
|
|
13078
13353
|
* @export
|
|
@@ -13174,7 +13449,7 @@ export declare const RoleCriteriaOperation: {
|
|
|
13174
13449
|
readonly And: "AND";
|
|
13175
13450
|
readonly Or: "OR";
|
|
13176
13451
|
};
|
|
13177
|
-
export
|
|
13452
|
+
export type RoleCriteriaOperation = typeof RoleCriteriaOperation[keyof typeof RoleCriteriaOperation];
|
|
13178
13453
|
/**
|
|
13179
13454
|
* Role
|
|
13180
13455
|
* @export
|
|
@@ -13393,7 +13668,7 @@ export declare const RoleMembershipSelectorType: {
|
|
|
13393
13668
|
readonly Standard: "STANDARD";
|
|
13394
13669
|
readonly IdentityList: "IDENTITY_LIST";
|
|
13395
13670
|
};
|
|
13396
|
-
export
|
|
13671
|
+
export type RoleMembershipSelectorType = typeof RoleMembershipSelectorType[keyof typeof RoleMembershipSelectorType];
|
|
13397
13672
|
/**
|
|
13398
13673
|
* Role
|
|
13399
13674
|
* @export
|
|
@@ -13478,7 +13753,7 @@ export interface RoleSummaryAllOf {
|
|
|
13478
13753
|
* @type Rule
|
|
13479
13754
|
* @export
|
|
13480
13755
|
*/
|
|
13481
|
-
export
|
|
13756
|
+
export type Rule = GenerateRandomString | GenericRule | GetReferenceIdentityAttribute;
|
|
13482
13757
|
/**
|
|
13483
13758
|
*
|
|
13484
13759
|
* @export
|
|
@@ -13796,7 +14071,7 @@ export declare const ScheduleType: {
|
|
|
13796
14071
|
readonly Monthly: "MONTHLY";
|
|
13797
14072
|
readonly Calendar: "CALENDAR";
|
|
13798
14073
|
};
|
|
13799
|
-
export
|
|
14074
|
+
export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType];
|
|
13800
14075
|
/**
|
|
13801
14076
|
*
|
|
13802
14077
|
* @export
|
|
@@ -13931,7 +14206,7 @@ export interface ScheduledSearchAllOfOwner {
|
|
|
13931
14206
|
export declare const ScheduledSearchAllOfOwnerTypeEnum: {
|
|
13932
14207
|
readonly Identity: "IDENTITY";
|
|
13933
14208
|
};
|
|
13934
|
-
export
|
|
14209
|
+
export type ScheduledSearchAllOfOwnerTypeEnum = typeof ScheduledSearchAllOfOwnerTypeEnum[keyof typeof ScheduledSearchAllOfOwnerTypeEnum];
|
|
13935
14210
|
/**
|
|
13936
14211
|
*
|
|
13937
14212
|
* @export
|
|
@@ -14066,6 +14341,12 @@ export interface Search {
|
|
|
14066
14341
|
* @memberof Search
|
|
14067
14342
|
*/
|
|
14068
14343
|
'queryDsl'?: object;
|
|
14344
|
+
/**
|
|
14345
|
+
*
|
|
14346
|
+
* @type {TextQuery}
|
|
14347
|
+
* @memberof Search
|
|
14348
|
+
*/
|
|
14349
|
+
'textQuery'?: TextQuery;
|
|
14069
14350
|
/**
|
|
14070
14351
|
*
|
|
14071
14352
|
* @type {TypeAheadQuery}
|
|
@@ -14227,7 +14508,7 @@ export interface SearchArgumentsOwner {
|
|
|
14227
14508
|
* @type SearchDocument
|
|
14228
14509
|
* @export
|
|
14229
14510
|
*/
|
|
14230
|
-
export
|
|
14511
|
+
export type SearchDocument = AccessProfileDocument | AccountActivityDocument | AccountDocument | AggregationDocument | EntitlementDocument | EventDocument | IdentityDocument | RoleDocument;
|
|
14231
14512
|
/**
|
|
14232
14513
|
* Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice.
|
|
14233
14514
|
* @export
|
|
@@ -14236,7 +14517,7 @@ export declare type SearchDocument = AccessProfileDocument | AccountActivityDocu
|
|
|
14236
14517
|
export declare const SearchFilterType: {
|
|
14237
14518
|
readonly Term: "TERM";
|
|
14238
14519
|
};
|
|
14239
|
-
export
|
|
14520
|
+
export type SearchFilterType = typeof SearchFilterType[keyof typeof SearchFilterType];
|
|
14240
14521
|
/**
|
|
14241
14522
|
*
|
|
14242
14523
|
* @export
|
|
@@ -14352,7 +14633,7 @@ export interface SearchScheduleRecipientsInner {
|
|
|
14352
14633
|
export declare const SearchScheduleRecipientsInnerTypeEnum: {
|
|
14353
14634
|
readonly Identity: "IDENTITY";
|
|
14354
14635
|
};
|
|
14355
|
-
export
|
|
14636
|
+
export type SearchScheduleRecipientsInnerTypeEnum = typeof SearchScheduleRecipientsInnerTypeEnum[keyof typeof SearchScheduleRecipientsInnerTypeEnum];
|
|
14356
14637
|
/**
|
|
14357
14638
|
*
|
|
14358
14639
|
* @export
|
|
@@ -14486,7 +14767,7 @@ export declare const SelectorType: {
|
|
|
14486
14767
|
readonly List: "LIST";
|
|
14487
14768
|
readonly Range: "RANGE";
|
|
14488
14769
|
};
|
|
14489
|
-
export
|
|
14770
|
+
export type SelectorType = typeof SelectorType[keyof typeof SelectorType];
|
|
14490
14771
|
/**
|
|
14491
14772
|
*
|
|
14492
14773
|
* @export
|
|
@@ -14795,7 +15076,7 @@ export interface SlimCampaign {
|
|
|
14795
15076
|
*/
|
|
14796
15077
|
'description': string;
|
|
14797
15078
|
/**
|
|
14798
|
-
* The campaign\'s completion deadline.
|
|
15079
|
+
* The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.
|
|
14799
15080
|
* @type {string}
|
|
14800
15081
|
* @memberof SlimCampaign
|
|
14801
15082
|
*/
|
|
@@ -14843,7 +15124,7 @@ export declare const SlimCampaignTypeEnum: {
|
|
|
14843
15124
|
readonly Search: "SEARCH";
|
|
14844
15125
|
readonly RoleComposition: "ROLE_COMPOSITION";
|
|
14845
15126
|
};
|
|
14846
|
-
export
|
|
15127
|
+
export type SlimCampaignTypeEnum = typeof SlimCampaignTypeEnum[keyof typeof SlimCampaignTypeEnum];
|
|
14847
15128
|
export declare const SlimCampaignStatusEnum: {
|
|
14848
15129
|
readonly Pending: "PENDING";
|
|
14849
15130
|
readonly Staged: "STAGED";
|
|
@@ -14855,12 +15136,12 @@ export declare const SlimCampaignStatusEnum: {
|
|
|
14855
15136
|
readonly Error: "ERROR";
|
|
14856
15137
|
readonly Archived: "ARCHIVED";
|
|
14857
15138
|
};
|
|
14858
|
-
export
|
|
15139
|
+
export type SlimCampaignStatusEnum = typeof SlimCampaignStatusEnum[keyof typeof SlimCampaignStatusEnum];
|
|
14859
15140
|
export declare const SlimCampaignCorrelatedStatusEnum: {
|
|
14860
15141
|
readonly Correlated: "CORRELATED";
|
|
14861
15142
|
readonly Uncorrelated: "UNCORRELATED";
|
|
14862
15143
|
};
|
|
14863
|
-
export
|
|
15144
|
+
export type SlimCampaignCorrelatedStatusEnum = typeof SlimCampaignCorrelatedStatusEnum[keyof typeof SlimCampaignCorrelatedStatusEnum];
|
|
14864
15145
|
/**
|
|
14865
15146
|
* Details of the Entitlement criteria
|
|
14866
15147
|
* @export
|
|
@@ -15011,12 +15292,12 @@ export declare const SodPolicyStateEnum: {
|
|
|
15011
15292
|
readonly Enforced: "ENFORCED";
|
|
15012
15293
|
readonly NotEnforced: "NOT_ENFORCED";
|
|
15013
15294
|
};
|
|
15014
|
-
export
|
|
15295
|
+
export type SodPolicyStateEnum = typeof SodPolicyStateEnum[keyof typeof SodPolicyStateEnum];
|
|
15015
15296
|
export declare const SodPolicyTypeEnum: {
|
|
15016
15297
|
readonly General: "GENERAL";
|
|
15017
15298
|
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
15018
15299
|
};
|
|
15019
|
-
export
|
|
15300
|
+
export type SodPolicyTypeEnum = typeof SodPolicyTypeEnum[keyof typeof SodPolicyTypeEnum];
|
|
15020
15301
|
/**
|
|
15021
15302
|
*
|
|
15022
15303
|
* @export
|
|
@@ -15197,7 +15478,7 @@ export declare const SodViolationContextCheckCompletedStateEnum: {
|
|
|
15197
15478
|
readonly Success: "SUCCESS";
|
|
15198
15479
|
readonly Error: "ERROR";
|
|
15199
15480
|
};
|
|
15200
|
-
export
|
|
15481
|
+
export type SodViolationContextCheckCompletedStateEnum = typeof SodViolationContextCheckCompletedStateEnum[keyof typeof SodViolationContextCheckCompletedStateEnum];
|
|
15201
15482
|
/**
|
|
15202
15483
|
* The object which contains the left and right hand side of the entitlements that got violated according to the policy.
|
|
15203
15484
|
* @export
|
|
@@ -15393,11 +15674,11 @@ export interface Source {
|
|
|
15393
15674
|
*/
|
|
15394
15675
|
'connectionType'?: string;
|
|
15395
15676
|
/**
|
|
15396
|
-
* The connector
|
|
15677
|
+
* The connector implementation id
|
|
15397
15678
|
* @type {string}
|
|
15398
15679
|
* @memberof Source
|
|
15399
15680
|
*/
|
|
15400
|
-
'
|
|
15681
|
+
'connectorImplementationId'?: string;
|
|
15401
15682
|
}
|
|
15402
15683
|
/**
|
|
15403
15684
|
* Reference to an Account Correlation Config object
|
|
@@ -15427,7 +15708,7 @@ export interface SourceAccountCorrelationConfig {
|
|
|
15427
15708
|
export declare const SourceAccountCorrelationConfigTypeEnum: {
|
|
15428
15709
|
readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG";
|
|
15429
15710
|
};
|
|
15430
|
-
export
|
|
15711
|
+
export type SourceAccountCorrelationConfigTypeEnum = typeof SourceAccountCorrelationConfigTypeEnum[keyof typeof SourceAccountCorrelationConfigTypeEnum];
|
|
15431
15712
|
/**
|
|
15432
15713
|
* Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can\'t be used.
|
|
15433
15714
|
* @export
|
|
@@ -15456,7 +15737,7 @@ export interface SourceAccountCorrelationRule {
|
|
|
15456
15737
|
export declare const SourceAccountCorrelationRuleTypeEnum: {
|
|
15457
15738
|
readonly Rule: "RULE";
|
|
15458
15739
|
};
|
|
15459
|
-
export
|
|
15740
|
+
export type SourceAccountCorrelationRuleTypeEnum = typeof SourceAccountCorrelationRuleTypeEnum[keyof typeof SourceAccountCorrelationRuleTypeEnum];
|
|
15460
15741
|
/**
|
|
15461
15742
|
* Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
|
|
15462
15743
|
* @export
|
|
@@ -15485,7 +15766,7 @@ export interface SourceBeforeProvisioningRule {
|
|
|
15485
15766
|
export declare const SourceBeforeProvisioningRuleTypeEnum: {
|
|
15486
15767
|
readonly Rule: "RULE";
|
|
15487
15768
|
};
|
|
15488
|
-
export
|
|
15769
|
+
export type SourceBeforeProvisioningRuleTypeEnum = typeof SourceBeforeProvisioningRuleTypeEnum[keyof typeof SourceBeforeProvisioningRuleTypeEnum];
|
|
15489
15770
|
/**
|
|
15490
15771
|
* Reference to the associated Cluster
|
|
15491
15772
|
* @export
|
|
@@ -15497,24 +15778,24 @@ export interface SourceCluster {
|
|
|
15497
15778
|
* @type {string}
|
|
15498
15779
|
* @memberof SourceCluster
|
|
15499
15780
|
*/
|
|
15500
|
-
'type'
|
|
15781
|
+
'type': SourceClusterTypeEnum;
|
|
15501
15782
|
/**
|
|
15502
15783
|
* ID of the cluster
|
|
15503
15784
|
* @type {string}
|
|
15504
15785
|
* @memberof SourceCluster
|
|
15505
15786
|
*/
|
|
15506
|
-
'id'
|
|
15787
|
+
'id': string;
|
|
15507
15788
|
/**
|
|
15508
15789
|
* Human-readable display name of the cluster
|
|
15509
15790
|
* @type {string}
|
|
15510
15791
|
* @memberof SourceCluster
|
|
15511
15792
|
*/
|
|
15512
|
-
'name'
|
|
15793
|
+
'name': string;
|
|
15513
15794
|
}
|
|
15514
15795
|
export declare const SourceClusterTypeEnum: {
|
|
15515
15796
|
readonly Cluster: "CLUSTER";
|
|
15516
15797
|
};
|
|
15517
|
-
export
|
|
15798
|
+
export type SourceClusterTypeEnum = typeof SourceClusterTypeEnum[keyof typeof SourceClusterTypeEnum];
|
|
15518
15799
|
/**
|
|
15519
15800
|
* Optional features that can be supported by an source. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
|
|
15520
15801
|
* @export
|
|
@@ -15548,7 +15829,7 @@ export declare const SourceFeature: {
|
|
|
15548
15829
|
readonly NoUnstructuredTargetsProvisioning: "NO_UNSTRUCTURED_TARGETS_PROVISIONING";
|
|
15549
15830
|
readonly NoDirectPermissionsProvisioning: "NO_DIRECT_PERMISSIONS_PROVISIONING";
|
|
15550
15831
|
};
|
|
15551
|
-
export
|
|
15832
|
+
export type SourceFeature = typeof SourceFeature[keyof typeof SourceFeature];
|
|
15552
15833
|
/**
|
|
15553
15834
|
* Dto for source health data
|
|
15554
15835
|
* @export
|
|
@@ -15628,7 +15909,7 @@ export declare const SourceHealthDtoStatusEnum: {
|
|
|
15628
15909
|
readonly UncheckedSource: "SOURCE_STATE_UNCHECKED_SOURCE";
|
|
15629
15910
|
readonly UncheckedSourceNoAccounts: "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS";
|
|
15630
15911
|
};
|
|
15631
|
-
export
|
|
15912
|
+
export type SourceHealthDtoStatusEnum = typeof SourceHealthDtoStatusEnum[keyof typeof SourceHealthDtoStatusEnum];
|
|
15632
15913
|
/**
|
|
15633
15914
|
* Reference to Management Workgroup for this Source
|
|
15634
15915
|
* @export
|
|
@@ -15657,7 +15938,7 @@ export interface SourceManagementWorkgroup {
|
|
|
15657
15938
|
export declare const SourceManagementWorkgroupTypeEnum: {
|
|
15658
15939
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
15659
15940
|
};
|
|
15660
|
-
export
|
|
15941
|
+
export type SourceManagementWorkgroupTypeEnum = typeof SourceManagementWorkgroupTypeEnum[keyof typeof SourceManagementWorkgroupTypeEnum];
|
|
15661
15942
|
/**
|
|
15662
15943
|
* Reference to the ManagerCorrelationRule, only used when a simple filter isn\'t sufficient.
|
|
15663
15944
|
* @export
|
|
@@ -15686,7 +15967,7 @@ export interface SourceManagerCorrelationRule {
|
|
|
15686
15967
|
export declare const SourceManagerCorrelationRuleTypeEnum: {
|
|
15687
15968
|
readonly Rule: "RULE";
|
|
15688
15969
|
};
|
|
15689
|
-
export
|
|
15970
|
+
export type SourceManagerCorrelationRuleTypeEnum = typeof SourceManagerCorrelationRuleTypeEnum[keyof typeof SourceManagerCorrelationRuleTypeEnum];
|
|
15690
15971
|
/**
|
|
15691
15972
|
* Reference to an owning Identity Object
|
|
15692
15973
|
* @export
|
|
@@ -15715,7 +15996,7 @@ export interface SourceOwner {
|
|
|
15715
15996
|
export declare const SourceOwnerTypeEnum: {
|
|
15716
15997
|
readonly Identity: "IDENTITY";
|
|
15717
15998
|
};
|
|
15718
|
-
export
|
|
15999
|
+
export type SourceOwnerTypeEnum = typeof SourceOwnerTypeEnum[keyof typeof SourceOwnerTypeEnum];
|
|
15719
16000
|
/**
|
|
15720
16001
|
*
|
|
15721
16002
|
* @export
|
|
@@ -15744,7 +16025,7 @@ export interface SourcePasswordPoliciesInner {
|
|
|
15744
16025
|
export declare const SourcePasswordPoliciesInnerTypeEnum: {
|
|
15745
16026
|
readonly PasswordPolicy: "PASSWORD_POLICY";
|
|
15746
16027
|
};
|
|
15747
|
-
export
|
|
16028
|
+
export type SourcePasswordPoliciesInnerTypeEnum = typeof SourcePasswordPoliciesInnerTypeEnum[keyof typeof SourcePasswordPoliciesInnerTypeEnum];
|
|
15748
16029
|
/**
|
|
15749
16030
|
*
|
|
15750
16031
|
* @export
|
|
@@ -15773,7 +16054,7 @@ export interface SourceSchemasInner {
|
|
|
15773
16054
|
export declare const SourceSchemasInnerTypeEnum: {
|
|
15774
16055
|
readonly ConnectorSchema: "CONNECTOR_SCHEMA";
|
|
15775
16056
|
};
|
|
15776
|
-
export
|
|
16057
|
+
export type SourceSchemasInnerTypeEnum = typeof SourceSchemasInnerTypeEnum[keyof typeof SourceSchemasInnerTypeEnum];
|
|
15777
16058
|
/**
|
|
15778
16059
|
* Message model for Config Import/Export.
|
|
15779
16060
|
* @export
|
|
@@ -15998,6 +16279,94 @@ export interface TaggedObjectDto {
|
|
|
15998
16279
|
*/
|
|
15999
16280
|
'name'?: string | null;
|
|
16000
16281
|
}
|
|
16282
|
+
/**
|
|
16283
|
+
*
|
|
16284
|
+
* @export
|
|
16285
|
+
* @interface TaskResultSimplified
|
|
16286
|
+
*/
|
|
16287
|
+
export interface TaskResultSimplified {
|
|
16288
|
+
/**
|
|
16289
|
+
* Task identifier
|
|
16290
|
+
* @type {string}
|
|
16291
|
+
* @memberof TaskResultSimplified
|
|
16292
|
+
*/
|
|
16293
|
+
'id'?: string;
|
|
16294
|
+
/**
|
|
16295
|
+
* Task name
|
|
16296
|
+
* @type {string}
|
|
16297
|
+
* @memberof TaskResultSimplified
|
|
16298
|
+
*/
|
|
16299
|
+
'name'?: string;
|
|
16300
|
+
/**
|
|
16301
|
+
* Task description
|
|
16302
|
+
* @type {string}
|
|
16303
|
+
* @memberof TaskResultSimplified
|
|
16304
|
+
*/
|
|
16305
|
+
'description'?: string;
|
|
16306
|
+
/**
|
|
16307
|
+
* User or process who launched the task
|
|
16308
|
+
* @type {string}
|
|
16309
|
+
* @memberof TaskResultSimplified
|
|
16310
|
+
*/
|
|
16311
|
+
'launcher'?: string;
|
|
16312
|
+
/**
|
|
16313
|
+
* Date time of completion
|
|
16314
|
+
* @type {string}
|
|
16315
|
+
* @memberof TaskResultSimplified
|
|
16316
|
+
*/
|
|
16317
|
+
'completed'?: string;
|
|
16318
|
+
/**
|
|
16319
|
+
* Date time when the task was launched
|
|
16320
|
+
* @type {string}
|
|
16321
|
+
* @memberof TaskResultSimplified
|
|
16322
|
+
*/
|
|
16323
|
+
'launched'?: string;
|
|
16324
|
+
/**
|
|
16325
|
+
* Task result status
|
|
16326
|
+
* @type {string}
|
|
16327
|
+
* @memberof TaskResultSimplified
|
|
16328
|
+
*/
|
|
16329
|
+
'completionStatus'?: TaskResultSimplifiedCompletionStatusEnum;
|
|
16330
|
+
}
|
|
16331
|
+
export declare const TaskResultSimplifiedCompletionStatusEnum: {
|
|
16332
|
+
readonly Success: "Success";
|
|
16333
|
+
readonly Warning: "Warning";
|
|
16334
|
+
readonly Error: "Error";
|
|
16335
|
+
readonly Terminated: "Terminated";
|
|
16336
|
+
readonly TempError: "TempError";
|
|
16337
|
+
};
|
|
16338
|
+
export type TaskResultSimplifiedCompletionStatusEnum = typeof TaskResultSimplifiedCompletionStatusEnum[keyof typeof TaskResultSimplifiedCompletionStatusEnum];
|
|
16339
|
+
/**
|
|
16340
|
+
* Query parameters used to construct an Elasticsearch text query object.
|
|
16341
|
+
* @export
|
|
16342
|
+
* @interface TextQuery
|
|
16343
|
+
*/
|
|
16344
|
+
export interface TextQuery {
|
|
16345
|
+
/**
|
|
16346
|
+
* Words or characters that specify a particular thing to be searched for.
|
|
16347
|
+
* @type {Array<string>}
|
|
16348
|
+
* @memberof TextQuery
|
|
16349
|
+
*/
|
|
16350
|
+
'terms': Array<string>;
|
|
16351
|
+
/**
|
|
16352
|
+
* The fields to be searched.
|
|
16353
|
+
* @type {Array<string>}
|
|
16354
|
+
* @memberof TextQuery
|
|
16355
|
+
*/
|
|
16356
|
+
'fields': Array<string>;
|
|
16357
|
+
/**
|
|
16358
|
+
* Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.
|
|
16359
|
+
* @type {boolean}
|
|
16360
|
+
* @memberof TextQuery
|
|
16361
|
+
*/
|
|
16362
|
+
'matchAny'?: boolean;
|
|
16363
|
+
/**
|
|
16364
|
+
* Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.
|
|
16365
|
+
* @type {boolean}
|
|
16366
|
+
* @memberof TextQuery
|
|
16367
|
+
*/
|
|
16368
|
+
'contains'?: boolean;
|
|
16369
|
+
}
|
|
16001
16370
|
/**
|
|
16002
16371
|
* The representation of an internally- or customer-defined transform.
|
|
16003
16372
|
* @export
|
|
@@ -16070,13 +16439,13 @@ export declare const TransformTypeEnum: {
|
|
|
16070
16439
|
readonly UsernameGenerator: "usernameGenerator";
|
|
16071
16440
|
readonly Uuid: "uuid";
|
|
16072
16441
|
};
|
|
16073
|
-
export
|
|
16442
|
+
export type TransformTypeEnum = typeof TransformTypeEnum[keyof typeof TransformTypeEnum];
|
|
16074
16443
|
/**
|
|
16075
16444
|
* @type TransformAttributes
|
|
16076
16445
|
* Meta-data about the transform. Values in this list are specific to the type of transform to be executed.
|
|
16077
16446
|
* @export
|
|
16078
16447
|
*/
|
|
16079
|
-
export
|
|
16448
|
+
export type TransformAttributes = AccountAttribute | Base64Decode | Base64Encode | Concatenation | Conditional | DateCompare | DateFormat | DateMath | DecomposeDiacriticalMarks | E164phone | FirstValid | ISO3166 | IdentityAttribute | IndexOf | LeftPad | Lookup | Lower | NameNormalizer | RandomAlphaNumeric | RandomNumeric | Reference | Replace | ReplaceAll | RightPad | Rule | Split | Static | Substring | Trim | UUIDGenerator | Upper;
|
|
16080
16449
|
/**
|
|
16081
16450
|
*
|
|
16082
16451
|
* @export
|
|
@@ -16224,13 +16593,15 @@ export interface Upper {
|
|
|
16224
16593
|
};
|
|
16225
16594
|
}
|
|
16226
16595
|
/**
|
|
16227
|
-
* The type of
|
|
16596
|
+
* The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
16228
16597
|
* @export
|
|
16229
16598
|
* @enum {string}
|
|
16230
16599
|
*/
|
|
16231
16600
|
export declare const UsageType: {
|
|
16232
16601
|
readonly Create: "CREATE";
|
|
16233
16602
|
readonly Update: "UPDATE";
|
|
16603
|
+
readonly Enable: "ENABLE";
|
|
16604
|
+
readonly Disable: "DISABLE";
|
|
16234
16605
|
readonly Delete: "DELETE";
|
|
16235
16606
|
readonly Assign: "ASSIGN";
|
|
16236
16607
|
readonly Unassign: "UNASSIGN";
|
|
@@ -16241,12 +16612,10 @@ export declare const UsageType: {
|
|
|
16241
16612
|
readonly CreateIdentity: "CREATE_IDENTITY";
|
|
16242
16613
|
readonly UpdateIdentity: "UPDATE_IDENTITY";
|
|
16243
16614
|
readonly EditGroup: "EDIT_GROUP";
|
|
16244
|
-
readonly Enable: "ENABLE";
|
|
16245
|
-
readonly Disable: "DISABLE";
|
|
16246
16615
|
readonly Unlock: "UNLOCK";
|
|
16247
16616
|
readonly ChangePassword: "CHANGE_PASSWORD";
|
|
16248
16617
|
};
|
|
16249
|
-
export
|
|
16618
|
+
export type UsageType = typeof UsageType[keyof typeof UsageType];
|
|
16250
16619
|
/**
|
|
16251
16620
|
*
|
|
16252
16621
|
* @export
|
|
@@ -16313,7 +16682,7 @@ export interface ViolationContextPolicy {
|
|
|
16313
16682
|
export declare const ViolationContextPolicyTypeEnum: {
|
|
16314
16683
|
readonly Entitlement: "ENTITLEMENT";
|
|
16315
16684
|
};
|
|
16316
|
-
export
|
|
16685
|
+
export type ViolationContextPolicyTypeEnum = typeof ViolationContextPolicyTypeEnum[keyof typeof ViolationContextPolicyTypeEnum];
|
|
16317
16686
|
/**
|
|
16318
16687
|
*
|
|
16319
16688
|
* @export
|
|
@@ -16357,7 +16726,7 @@ export declare const ViolationOwnerAssignmentConfigAssignmentRuleEnum: {
|
|
|
16357
16726
|
readonly Static: "STATIC";
|
|
16358
16727
|
readonly Null: "null";
|
|
16359
16728
|
};
|
|
16360
|
-
export
|
|
16729
|
+
export type ViolationOwnerAssignmentConfigAssignmentRuleEnum = typeof ViolationOwnerAssignmentConfigAssignmentRuleEnum[keyof typeof ViolationOwnerAssignmentConfigAssignmentRuleEnum];
|
|
16361
16730
|
/**
|
|
16362
16731
|
*
|
|
16363
16732
|
* @export
|
|
@@ -16422,7 +16791,7 @@ export declare const WorkItemState: {
|
|
|
16422
16791
|
readonly Pending: "PENDING";
|
|
16423
16792
|
readonly Canceled: "CANCELED";
|
|
16424
16793
|
};
|
|
16425
|
-
export
|
|
16794
|
+
export type WorkItemState = typeof WorkItemState[keyof typeof WorkItemState];
|
|
16426
16795
|
/**
|
|
16427
16796
|
* The type of the work item
|
|
16428
16797
|
* @export
|
|
@@ -16445,7 +16814,7 @@ export declare const WorkItemType: {
|
|
|
16445
16814
|
readonly Manualaction: "MANUALACTION";
|
|
16446
16815
|
readonly Test: "TEST";
|
|
16447
16816
|
};
|
|
16448
|
-
export
|
|
16817
|
+
export type WorkItemType = typeof WorkItemType[keyof typeof WorkItemType];
|
|
16449
16818
|
/**
|
|
16450
16819
|
*
|
|
16451
16820
|
* @export
|
|
@@ -16651,7 +17020,7 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
16651
17020
|
*/
|
|
16652
17021
|
listAccessProfiles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
16653
17022
|
/**
|
|
16654
|
-
* This API updates an existing Access Profile. The following fields are patchable:
|
|
17023
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. 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.
|
|
16655
17024
|
* @summary Patch a specified Access Profile
|
|
16656
17025
|
* @param {string} id ID of the Access Profile to patch
|
|
16657
17026
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
@@ -16718,7 +17087,7 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
16718
17087
|
*/
|
|
16719
17088
|
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>>>;
|
|
16720
17089
|
/**
|
|
16721
|
-
* This API updates an existing Access Profile. The following fields are patchable:
|
|
17090
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. 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.
|
|
16722
17091
|
* @summary Patch a specified Access Profile
|
|
16723
17092
|
* @param {string} id ID of the Access Profile to patch
|
|
16724
17093
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
@@ -16785,7 +17154,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
16785
17154
|
*/
|
|
16786
17155
|
listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: any): AxiosPromise<Array<AccessProfile>>;
|
|
16787
17156
|
/**
|
|
16788
|
-
* This API updates an existing Access Profile. The following fields are patchable:
|
|
17157
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. 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.
|
|
16789
17158
|
* @summary Patch a specified Access Profile
|
|
16790
17159
|
* @param {string} id ID of the Access Profile to patch
|
|
16791
17160
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
@@ -17003,7 +17372,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
17003
17372
|
*/
|
|
17004
17373
|
listAccessProfiles(requestParameters?: AccessProfilesApiListAccessProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile[], any>>;
|
|
17005
17374
|
/**
|
|
17006
|
-
* This API updates an existing Access Profile. The following fields are patchable:
|
|
17375
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. 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.
|
|
17007
17376
|
* @summary Patch a specified Access Profile
|
|
17008
17377
|
* @param {AccessProfilesApiPatchAccessProfileRequest} requestParameters Request parameters.
|
|
17009
17378
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -17454,7 +17823,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
17454
17823
|
*/
|
|
17455
17824
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
17456
17825
|
/**
|
|
17457
|
-
* 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
|
|
17826
|
+
* 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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 a `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] You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * 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.
|
|
17458
17827
|
* @summary Submit an Access Request
|
|
17459
17828
|
* @param {AccessRequest} accessRequest
|
|
17460
17829
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -17506,7 +17875,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
17506
17875
|
*/
|
|
17507
17876
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
17508
17877
|
/**
|
|
17509
|
-
* 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
|
|
17878
|
+
* 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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 a `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] You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * 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.
|
|
17510
17879
|
* @summary Submit an Access Request
|
|
17511
17880
|
* @param {AccessRequest} accessRequest
|
|
17512
17881
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -17558,7 +17927,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
17558
17927
|
*/
|
|
17559
17928
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
17560
17929
|
/**
|
|
17561
|
-
* 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
|
|
17930
|
+
* 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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 a `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] You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * 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.
|
|
17562
17931
|
* @summary Submit an Access Request
|
|
17563
17932
|
* @param {AccessRequest} accessRequest
|
|
17564
17933
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -17707,7 +18076,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
17707
18076
|
*/
|
|
17708
18077
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
17709
18078
|
/**
|
|
17710
|
-
* 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
|
|
18079
|
+
* 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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 a `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] You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * 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.
|
|
17711
18080
|
* @summary Submit an Access Request
|
|
17712
18081
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
17713
18082
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -18564,27 +18933,171 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
18564
18933
|
updateAccount(requestParameters: AccountsApiUpdateAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
18565
18934
|
}
|
|
18566
18935
|
/**
|
|
18567
|
-
*
|
|
18936
|
+
* AuthUserApi - axios parameter creator
|
|
18568
18937
|
* @export
|
|
18569
18938
|
*/
|
|
18570
|
-
export declare const
|
|
18939
|
+
export declare const AuthUserApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18571
18940
|
/**
|
|
18572
|
-
*
|
|
18573
|
-
* @summary
|
|
18574
|
-
* @param {
|
|
18941
|
+
* This API returns the specified user\'s authentication system details. Requires security scope of: \'sp:auth-user:read\'
|
|
18942
|
+
* @summary Auth User Details
|
|
18943
|
+
* @param {string} id Identity ID
|
|
18575
18944
|
* @param {*} [axiosOptions] Override http request option.
|
|
18576
18945
|
* @throws {RequiredError}
|
|
18577
18946
|
*/
|
|
18578
|
-
|
|
18947
|
+
getAuthUser: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18579
18948
|
/**
|
|
18580
|
-
*
|
|
18581
|
-
* @summary
|
|
18582
|
-
* @param {
|
|
18583
|
-
* @param {
|
|
18584
|
-
* @param {
|
|
18585
|
-
* @
|
|
18586
|
-
|
|
18587
|
-
|
|
18949
|
+
* Update an existing user in the authentication system with a PATCH request.
|
|
18950
|
+
* @summary Auth User Update
|
|
18951
|
+
* @param {string} id Identity ID
|
|
18952
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"capabilities\" A list of valid capabilities can be found using the GET ams/v3/authorization/authorization-capabilities/ endpoint. Capabilities can only be patched if they are administrator assignable, as indicated by the \'adminAssignable\' field from the output of list authorization-capabilities. Capabilities that have a legacy group (\'legacyGroup\' field) need to be patched using the legacyGroup name (e.g. \'ORG_ADMIN\'). Capabilities that are adminAssignable but do not have a legacyGroup can be patched using the ams id (e.g. \'cam:new-role\'). A 400.1.1 Illegal update attempt detail code indicates that you attempted to PATCH a field that is not allowed. Requires security scope of \'sp:auth-user:update\'
|
|
18953
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18954
|
+
* @throws {RequiredError}
|
|
18955
|
+
*/
|
|
18956
|
+
patchAuthUser: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18957
|
+
};
|
|
18958
|
+
/**
|
|
18959
|
+
* AuthUserApi - functional programming interface
|
|
18960
|
+
* @export
|
|
18961
|
+
*/
|
|
18962
|
+
export declare const AuthUserApiFp: (configuration?: Configuration) => {
|
|
18963
|
+
/**
|
|
18964
|
+
* This API returns the specified user\'s authentication system details. Requires security scope of: \'sp:auth-user:read\'
|
|
18965
|
+
* @summary Auth User Details
|
|
18966
|
+
* @param {string} id Identity ID
|
|
18967
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18968
|
+
* @throws {RequiredError}
|
|
18969
|
+
*/
|
|
18970
|
+
getAuthUser(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthUser>>;
|
|
18971
|
+
/**
|
|
18972
|
+
* Update an existing user in the authentication system with a PATCH request.
|
|
18973
|
+
* @summary Auth User Update
|
|
18974
|
+
* @param {string} id Identity ID
|
|
18975
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"capabilities\" A list of valid capabilities can be found using the GET ams/v3/authorization/authorization-capabilities/ endpoint. Capabilities can only be patched if they are administrator assignable, as indicated by the \'adminAssignable\' field from the output of list authorization-capabilities. Capabilities that have a legacy group (\'legacyGroup\' field) need to be patched using the legacyGroup name (e.g. \'ORG_ADMIN\'). Capabilities that are adminAssignable but do not have a legacyGroup can be patched using the ams id (e.g. \'cam:new-role\'). A 400.1.1 Illegal update attempt detail code indicates that you attempted to PATCH a field that is not allowed. Requires security scope of \'sp:auth-user:update\'
|
|
18976
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18977
|
+
* @throws {RequiredError}
|
|
18978
|
+
*/
|
|
18979
|
+
patchAuthUser(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthUser>>;
|
|
18980
|
+
};
|
|
18981
|
+
/**
|
|
18982
|
+
* AuthUserApi - factory interface
|
|
18983
|
+
* @export
|
|
18984
|
+
*/
|
|
18985
|
+
export declare const AuthUserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18986
|
+
/**
|
|
18987
|
+
* This API returns the specified user\'s authentication system details. Requires security scope of: \'sp:auth-user:read\'
|
|
18988
|
+
* @summary Auth User Details
|
|
18989
|
+
* @param {string} id Identity ID
|
|
18990
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
18991
|
+
* @throws {RequiredError}
|
|
18992
|
+
*/
|
|
18993
|
+
getAuthUser(id: string, axiosOptions?: any): AxiosPromise<AuthUser>;
|
|
18994
|
+
/**
|
|
18995
|
+
* Update an existing user in the authentication system with a PATCH request.
|
|
18996
|
+
* @summary Auth User Update
|
|
18997
|
+
* @param {string} id Identity ID
|
|
18998
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"capabilities\" A list of valid capabilities can be found using the GET ams/v3/authorization/authorization-capabilities/ endpoint. Capabilities can only be patched if they are administrator assignable, as indicated by the \'adminAssignable\' field from the output of list authorization-capabilities. Capabilities that have a legacy group (\'legacyGroup\' field) need to be patched using the legacyGroup name (e.g. \'ORG_ADMIN\'). Capabilities that are adminAssignable but do not have a legacyGroup can be patched using the ams id (e.g. \'cam:new-role\'). A 400.1.1 Illegal update attempt detail code indicates that you attempted to PATCH a field that is not allowed. Requires security scope of \'sp:auth-user:update\'
|
|
18999
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19000
|
+
* @throws {RequiredError}
|
|
19001
|
+
*/
|
|
19002
|
+
patchAuthUser(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<AuthUser>;
|
|
19003
|
+
};
|
|
19004
|
+
/**
|
|
19005
|
+
* Request parameters for getAuthUser operation in AuthUserApi.
|
|
19006
|
+
* @export
|
|
19007
|
+
* @interface AuthUserApiGetAuthUserRequest
|
|
19008
|
+
*/
|
|
19009
|
+
export interface AuthUserApiGetAuthUserRequest {
|
|
19010
|
+
/**
|
|
19011
|
+
* Identity ID
|
|
19012
|
+
* @type {string}
|
|
19013
|
+
* @memberof AuthUserApiGetAuthUser
|
|
19014
|
+
*/
|
|
19015
|
+
readonly id: string;
|
|
19016
|
+
}
|
|
19017
|
+
/**
|
|
19018
|
+
* Request parameters for patchAuthUser operation in AuthUserApi.
|
|
19019
|
+
* @export
|
|
19020
|
+
* @interface AuthUserApiPatchAuthUserRequest
|
|
19021
|
+
*/
|
|
19022
|
+
export interface AuthUserApiPatchAuthUserRequest {
|
|
19023
|
+
/**
|
|
19024
|
+
* Identity ID
|
|
19025
|
+
* @type {string}
|
|
19026
|
+
* @memberof AuthUserApiPatchAuthUser
|
|
19027
|
+
*/
|
|
19028
|
+
readonly id: string;
|
|
19029
|
+
/**
|
|
19030
|
+
* A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"capabilities\" A list of valid capabilities can be found using the GET ams/v3/authorization/authorization-capabilities/ endpoint. Capabilities can only be patched if they are administrator assignable, as indicated by the \'adminAssignable\' field from the output of list authorization-capabilities. Capabilities that have a legacy group (\'legacyGroup\' field) need to be patched using the legacyGroup name (e.g. \'ORG_ADMIN\'). Capabilities that are adminAssignable but do not have a legacyGroup can be patched using the ams id (e.g. \'cam:new-role\'). A 400.1.1 Illegal update attempt detail code indicates that you attempted to PATCH a field that is not allowed. Requires security scope of \'sp:auth-user:update\'
|
|
19031
|
+
* @type {Array<JsonPatchOperation>}
|
|
19032
|
+
* @memberof AuthUserApiPatchAuthUser
|
|
19033
|
+
*/
|
|
19034
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
19035
|
+
}
|
|
19036
|
+
/**
|
|
19037
|
+
* AuthUserApi - object-oriented interface
|
|
19038
|
+
* @export
|
|
19039
|
+
* @class AuthUserApi
|
|
19040
|
+
* @extends {BaseAPI}
|
|
19041
|
+
*/
|
|
19042
|
+
export declare class AuthUserApi extends BaseAPI {
|
|
19043
|
+
/**
|
|
19044
|
+
* This API returns the specified user\'s authentication system details. Requires security scope of: \'sp:auth-user:read\'
|
|
19045
|
+
* @summary Auth User Details
|
|
19046
|
+
* @param {AuthUserApiGetAuthUserRequest} requestParameters Request parameters.
|
|
19047
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19048
|
+
* @throws {RequiredError}
|
|
19049
|
+
* @memberof AuthUserApi
|
|
19050
|
+
*/
|
|
19051
|
+
getAuthUser(requestParameters: AuthUserApiGetAuthUserRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthUser, any>>;
|
|
19052
|
+
/**
|
|
19053
|
+
* Update an existing user in the authentication system with a PATCH request.
|
|
19054
|
+
* @summary Auth User Update
|
|
19055
|
+
* @param {AuthUserApiPatchAuthUserRequest} requestParameters Request parameters.
|
|
19056
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19057
|
+
* @throws {RequiredError}
|
|
19058
|
+
* @memberof AuthUserApi
|
|
19059
|
+
*/
|
|
19060
|
+
patchAuthUser(requestParameters: AuthUserApiPatchAuthUserRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthUser, any>>;
|
|
19061
|
+
}
|
|
19062
|
+
/**
|
|
19063
|
+
* CertificationCampaignsApi - axios parameter creator
|
|
19064
|
+
* @export
|
|
19065
|
+
*/
|
|
19066
|
+
export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19067
|
+
/**
|
|
19068
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Completes a certification campaign. This is provided to admins so that they can complete a certification even if all items have not been completed. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19069
|
+
* @summary Complete a Campaign
|
|
19070
|
+
* @param {string} id The campaign id
|
|
19071
|
+
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
19072
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19073
|
+
* @throws {RequiredError}
|
|
19074
|
+
*/
|
|
19075
|
+
completeCampaign: (id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19076
|
+
/**
|
|
19077
|
+
* Creates a new Certification Campaign with the information provided in the request body.
|
|
19078
|
+
* @summary Create a campaign
|
|
19079
|
+
* @param {Campaign} campaign
|
|
19080
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19081
|
+
* @throws {RequiredError}
|
|
19082
|
+
*/
|
|
19083
|
+
createCampaign: (campaign: Campaign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19084
|
+
/**
|
|
19085
|
+
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19086
|
+
* @summary Deletes Campaigns
|
|
19087
|
+
* @param {CampaignsDeleteRequest} campaignsDeleteRequest The ids of the campaigns to delete.
|
|
19088
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19089
|
+
* @throws {RequiredError}
|
|
19090
|
+
*/
|
|
19091
|
+
deleteCampaigns: (campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19092
|
+
/**
|
|
19093
|
+
* Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.
|
|
19094
|
+
* @summary List Campaigns
|
|
19095
|
+
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
19096
|
+
* @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.
|
|
19097
|
+
* @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.
|
|
19098
|
+
* @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.
|
|
19099
|
+
* @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* **status**: *eq, in*
|
|
19100
|
+
* @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**
|
|
18588
19101
|
* @param {*} [axiosOptions] Override http request option.
|
|
18589
19102
|
* @throws {RequiredError}
|
|
18590
19103
|
*/
|
|
@@ -18597,6 +19110,21 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
18597
19110
|
* @throws {RequiredError}
|
|
18598
19111
|
*/
|
|
18599
19112
|
getCampaign: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19113
|
+
/**
|
|
19114
|
+
* Fetches all reports for a certification campaign by campaign ID. Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN
|
|
19115
|
+
* @summary Get Campaign Reports
|
|
19116
|
+
* @param {string} campaignId The ID of the campaign for which reports are being fetched.
|
|
19117
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19118
|
+
* @throws {RequiredError}
|
|
19119
|
+
*/
|
|
19120
|
+
getCampaignReports: (campaignId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19121
|
+
/**
|
|
19122
|
+
* Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. Requires roles of CERT_ADMIN and ORG_ADMIN.
|
|
19123
|
+
* @summary Get Campaign Reports Configuration
|
|
19124
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19125
|
+
* @throws {RequiredError}
|
|
19126
|
+
*/
|
|
19127
|
+
getCampaignReportsConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18600
19128
|
/**
|
|
18601
19129
|
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
18602
19130
|
* @summary Reassign Certifications
|
|
@@ -18606,12 +19134,64 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
18606
19134
|
* @throws {RequiredError}
|
|
18607
19135
|
*/
|
|
18608
19136
|
move: (id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19137
|
+
/**
|
|
19138
|
+
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19139
|
+
* @summary Set Campaign Reports Configuration
|
|
19140
|
+
* @param {CampaignReportsConfig} campaignReportsConfig Campaign Report Configuration
|
|
19141
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19142
|
+
* @throws {RequiredError}
|
|
19143
|
+
*/
|
|
19144
|
+
setCampaignReportsConfig: (campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19145
|
+
/**
|
|
19146
|
+
* Submits a job to activate the campaign with the given Id. The campaign must be staged. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19147
|
+
* @summary Activate a Campaign
|
|
19148
|
+
* @param {string} id The campaign id
|
|
19149
|
+
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
19150
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19151
|
+
* @throws {RequiredError}
|
|
19152
|
+
*/
|
|
19153
|
+
startCampaign: (id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19154
|
+
/**
|
|
19155
|
+
* Kicks off remediation scan task for a certification campaign. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19156
|
+
* @summary Run Campaign Remediation Scan
|
|
19157
|
+
* @param {string} id The ID of the campaign for which remediation scan is being run.
|
|
19158
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19159
|
+
* @throws {RequiredError}
|
|
19160
|
+
*/
|
|
19161
|
+
startCampaignRemediationScan: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19162
|
+
/**
|
|
19163
|
+
* Runs a report for a certification campaign. Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
|
|
19164
|
+
* @summary Run Campaign Report
|
|
19165
|
+
* @param {string} id The ID of the campaign for which report is being run.
|
|
19166
|
+
* @param {ReportType} type The type of the report to run.
|
|
19167
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19168
|
+
* @throws {RequiredError}
|
|
19169
|
+
*/
|
|
19170
|
+
startCampaignReport: (id: string, type: ReportType, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19171
|
+
/**
|
|
19172
|
+
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19173
|
+
* @summary Update a Campaign
|
|
19174
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19175
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. In the *STAGED* status, the following fields can be patched: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed In the *ACTIVE* status, the following fields can be patched: * deadline
|
|
19176
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19177
|
+
* @throws {RequiredError}
|
|
19178
|
+
*/
|
|
19179
|
+
updateCampaign: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18609
19180
|
};
|
|
18610
19181
|
/**
|
|
18611
19182
|
* CertificationCampaignsApi - functional programming interface
|
|
18612
19183
|
* @export
|
|
18613
19184
|
*/
|
|
18614
19185
|
export declare const CertificationCampaignsApiFp: (configuration?: Configuration) => {
|
|
19186
|
+
/**
|
|
19187
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Completes a certification campaign. This is provided to admins so that they can complete a certification even if all items have not been completed. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19188
|
+
* @summary Complete a Campaign
|
|
19189
|
+
* @param {string} id The campaign id
|
|
19190
|
+
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
19191
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19192
|
+
* @throws {RequiredError}
|
|
19193
|
+
*/
|
|
19194
|
+
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
18615
19195
|
/**
|
|
18616
19196
|
* Creates a new Certification Campaign with the information provided in the request body.
|
|
18617
19197
|
* @summary Create a campaign
|
|
@@ -18620,6 +19200,14 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
18620
19200
|
* @throws {RequiredError}
|
|
18621
19201
|
*/
|
|
18622
19202
|
createCampaign(campaign: Campaign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Campaign>>;
|
|
19203
|
+
/**
|
|
19204
|
+
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19205
|
+
* @summary Deletes Campaigns
|
|
19206
|
+
* @param {CampaignsDeleteRequest} campaignsDeleteRequest The ids of the campaigns to delete.
|
|
19207
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19208
|
+
* @throws {RequiredError}
|
|
19209
|
+
*/
|
|
19210
|
+
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
18623
19211
|
/**
|
|
18624
19212
|
* Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.
|
|
18625
19213
|
* @summary List Campaigns
|
|
@@ -18641,6 +19229,21 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
18641
19229
|
* @throws {RequiredError}
|
|
18642
19230
|
*/
|
|
18643
19231
|
getCampaign(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SlimCampaign>>;
|
|
19232
|
+
/**
|
|
19233
|
+
* Fetches all reports for a certification campaign by campaign ID. Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN
|
|
19234
|
+
* @summary Get Campaign Reports
|
|
19235
|
+
* @param {string} campaignId The ID of the campaign for which reports are being fetched.
|
|
19236
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19237
|
+
* @throws {RequiredError}
|
|
19238
|
+
*/
|
|
19239
|
+
getCampaignReports(campaignId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignReport>>>;
|
|
19240
|
+
/**
|
|
19241
|
+
* Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. Requires roles of CERT_ADMIN and ORG_ADMIN.
|
|
19242
|
+
* @summary Get Campaign Reports Configuration
|
|
19243
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19244
|
+
* @throws {RequiredError}
|
|
19245
|
+
*/
|
|
19246
|
+
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
18644
19247
|
/**
|
|
18645
19248
|
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
18646
19249
|
* @summary Reassign Certifications
|
|
@@ -18650,12 +19253,64 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
18650
19253
|
* @throws {RequiredError}
|
|
18651
19254
|
*/
|
|
18652
19255
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
19256
|
+
/**
|
|
19257
|
+
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19258
|
+
* @summary Set Campaign Reports Configuration
|
|
19259
|
+
* @param {CampaignReportsConfig} campaignReportsConfig Campaign Report Configuration
|
|
19260
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19261
|
+
* @throws {RequiredError}
|
|
19262
|
+
*/
|
|
19263
|
+
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
19264
|
+
/**
|
|
19265
|
+
* Submits a job to activate the campaign with the given Id. The campaign must be staged. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19266
|
+
* @summary Activate a Campaign
|
|
19267
|
+
* @param {string} id The campaign id
|
|
19268
|
+
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
19269
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19270
|
+
* @throws {RequiredError}
|
|
19271
|
+
*/
|
|
19272
|
+
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
19273
|
+
/**
|
|
19274
|
+
* Kicks off remediation scan task for a certification campaign. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19275
|
+
* @summary Run Campaign Remediation Scan
|
|
19276
|
+
* @param {string} id The ID of the campaign for which remediation scan is being run.
|
|
19277
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19278
|
+
* @throws {RequiredError}
|
|
19279
|
+
*/
|
|
19280
|
+
startCampaignRemediationScan(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
19281
|
+
/**
|
|
19282
|
+
* Runs a report for a certification campaign. Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
|
|
19283
|
+
* @summary Run Campaign Report
|
|
19284
|
+
* @param {string} id The ID of the campaign for which report is being run.
|
|
19285
|
+
* @param {ReportType} type The type of the report to run.
|
|
19286
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19287
|
+
* @throws {RequiredError}
|
|
19288
|
+
*/
|
|
19289
|
+
startCampaignReport(id: string, type: ReportType, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
19290
|
+
/**
|
|
19291
|
+
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19292
|
+
* @summary Update a Campaign
|
|
19293
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19294
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. In the *STAGED* status, the following fields can be patched: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed In the *ACTIVE* status, the following fields can be patched: * deadline
|
|
19295
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19296
|
+
* @throws {RequiredError}
|
|
19297
|
+
*/
|
|
19298
|
+
updateCampaign(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SlimCampaign>>;
|
|
18653
19299
|
};
|
|
18654
19300
|
/**
|
|
18655
19301
|
* CertificationCampaignsApi - factory interface
|
|
18656
19302
|
* @export
|
|
18657
19303
|
*/
|
|
18658
19304
|
export declare const CertificationCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19305
|
+
/**
|
|
19306
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Completes a certification campaign. This is provided to admins so that they can complete a certification even if all items have not been completed. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19307
|
+
* @summary Complete a Campaign
|
|
19308
|
+
* @param {string} id The campaign id
|
|
19309
|
+
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
19310
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19311
|
+
* @throws {RequiredError}
|
|
19312
|
+
*/
|
|
19313
|
+
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
18659
19314
|
/**
|
|
18660
19315
|
* Creates a new Certification Campaign with the information provided in the request body.
|
|
18661
19316
|
* @summary Create a campaign
|
|
@@ -18664,6 +19319,14 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
18664
19319
|
* @throws {RequiredError}
|
|
18665
19320
|
*/
|
|
18666
19321
|
createCampaign(campaign: Campaign, axiosOptions?: any): AxiosPromise<Campaign>;
|
|
19322
|
+
/**
|
|
19323
|
+
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19324
|
+
* @summary Deletes Campaigns
|
|
19325
|
+
* @param {CampaignsDeleteRequest} campaignsDeleteRequest The ids of the campaigns to delete.
|
|
19326
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19327
|
+
* @throws {RequiredError}
|
|
19328
|
+
*/
|
|
19329
|
+
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
18667
19330
|
/**
|
|
18668
19331
|
* Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.
|
|
18669
19332
|
* @summary List Campaigns
|
|
@@ -18685,6 +19348,21 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
18685
19348
|
* @throws {RequiredError}
|
|
18686
19349
|
*/
|
|
18687
19350
|
getCampaign(id: string, axiosOptions?: any): AxiosPromise<SlimCampaign>;
|
|
19351
|
+
/**
|
|
19352
|
+
* Fetches all reports for a certification campaign by campaign ID. Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN
|
|
19353
|
+
* @summary Get Campaign Reports
|
|
19354
|
+
* @param {string} campaignId The ID of the campaign for which reports are being fetched.
|
|
19355
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19356
|
+
* @throws {RequiredError}
|
|
19357
|
+
*/
|
|
19358
|
+
getCampaignReports(campaignId: string, axiosOptions?: any): AxiosPromise<Array<CampaignReport>>;
|
|
19359
|
+
/**
|
|
19360
|
+
* Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. Requires roles of CERT_ADMIN and ORG_ADMIN.
|
|
19361
|
+
* @summary Get Campaign Reports Configuration
|
|
19362
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19363
|
+
* @throws {RequiredError}
|
|
19364
|
+
*/
|
|
19365
|
+
getCampaignReportsConfig(axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
18688
19366
|
/**
|
|
18689
19367
|
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
18690
19368
|
* @summary Reassign Certifications
|
|
@@ -18694,7 +19372,69 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
18694
19372
|
* @throws {RequiredError}
|
|
18695
19373
|
*/
|
|
18696
19374
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
19375
|
+
/**
|
|
19376
|
+
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19377
|
+
* @summary Set Campaign Reports Configuration
|
|
19378
|
+
* @param {CampaignReportsConfig} campaignReportsConfig Campaign Report Configuration
|
|
19379
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19380
|
+
* @throws {RequiredError}
|
|
19381
|
+
*/
|
|
19382
|
+
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
19383
|
+
/**
|
|
19384
|
+
* Submits a job to activate the campaign with the given Id. The campaign must be staged. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19385
|
+
* @summary Activate a Campaign
|
|
19386
|
+
* @param {string} id The campaign id
|
|
19387
|
+
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
19388
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19389
|
+
* @throws {RequiredError}
|
|
19390
|
+
*/
|
|
19391
|
+
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
19392
|
+
/**
|
|
19393
|
+
* Kicks off remediation scan task for a certification campaign. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19394
|
+
* @summary Run Campaign Remediation Scan
|
|
19395
|
+
* @param {string} id The ID of the campaign for which remediation scan is being run.
|
|
19396
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19397
|
+
* @throws {RequiredError}
|
|
19398
|
+
*/
|
|
19399
|
+
startCampaignRemediationScan(id: string, axiosOptions?: any): AxiosPromise<object>;
|
|
19400
|
+
/**
|
|
19401
|
+
* Runs a report for a certification campaign. Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
|
|
19402
|
+
* @summary Run Campaign Report
|
|
19403
|
+
* @param {string} id The ID of the campaign for which report is being run.
|
|
19404
|
+
* @param {ReportType} type The type of the report to run.
|
|
19405
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19406
|
+
* @throws {RequiredError}
|
|
19407
|
+
*/
|
|
19408
|
+
startCampaignReport(id: string, type: ReportType, axiosOptions?: any): AxiosPromise<object>;
|
|
19409
|
+
/**
|
|
19410
|
+
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19411
|
+
* @summary Update a Campaign
|
|
19412
|
+
* @param {string} id The ID of the campaign template being modified.
|
|
19413
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. In the *STAGED* status, the following fields can be patched: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed In the *ACTIVE* status, the following fields can be patched: * deadline
|
|
19414
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19415
|
+
* @throws {RequiredError}
|
|
19416
|
+
*/
|
|
19417
|
+
updateCampaign(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<SlimCampaign>;
|
|
18697
19418
|
};
|
|
19419
|
+
/**
|
|
19420
|
+
* Request parameters for completeCampaign operation in CertificationCampaignsApi.
|
|
19421
|
+
* @export
|
|
19422
|
+
* @interface CertificationCampaignsApiCompleteCampaignRequest
|
|
19423
|
+
*/
|
|
19424
|
+
export interface CertificationCampaignsApiCompleteCampaignRequest {
|
|
19425
|
+
/**
|
|
19426
|
+
* The campaign id
|
|
19427
|
+
* @type {string}
|
|
19428
|
+
* @memberof CertificationCampaignsApiCompleteCampaign
|
|
19429
|
+
*/
|
|
19430
|
+
readonly id: string;
|
|
19431
|
+
/**
|
|
19432
|
+
* Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
19433
|
+
* @type {CampaignCompleteOptions}
|
|
19434
|
+
* @memberof CertificationCampaignsApiCompleteCampaign
|
|
19435
|
+
*/
|
|
19436
|
+
readonly campaignCompleteOptions?: CampaignCompleteOptions;
|
|
19437
|
+
}
|
|
18698
19438
|
/**
|
|
18699
19439
|
* Request parameters for createCampaign operation in CertificationCampaignsApi.
|
|
18700
19440
|
* @export
|
|
@@ -18708,6 +19448,19 @@ export interface CertificationCampaignsApiCreateCampaignRequest {
|
|
|
18708
19448
|
*/
|
|
18709
19449
|
readonly campaign: Campaign;
|
|
18710
19450
|
}
|
|
19451
|
+
/**
|
|
19452
|
+
* Request parameters for deleteCampaigns operation in CertificationCampaignsApi.
|
|
19453
|
+
* @export
|
|
19454
|
+
* @interface CertificationCampaignsApiDeleteCampaignsRequest
|
|
19455
|
+
*/
|
|
19456
|
+
export interface CertificationCampaignsApiDeleteCampaignsRequest {
|
|
19457
|
+
/**
|
|
19458
|
+
* The ids of the campaigns to delete.
|
|
19459
|
+
* @type {CampaignsDeleteRequest}
|
|
19460
|
+
* @memberof CertificationCampaignsApiDeleteCampaigns
|
|
19461
|
+
*/
|
|
19462
|
+
readonly campaignsDeleteRequest: CampaignsDeleteRequest;
|
|
19463
|
+
}
|
|
18711
19464
|
/**
|
|
18712
19465
|
* Request parameters for getActiveCampaigns operation in CertificationCampaignsApi.
|
|
18713
19466
|
* @export
|
|
@@ -18764,6 +19517,19 @@ export interface CertificationCampaignsApiGetCampaignRequest {
|
|
|
18764
19517
|
*/
|
|
18765
19518
|
readonly id: string;
|
|
18766
19519
|
}
|
|
19520
|
+
/**
|
|
19521
|
+
* Request parameters for getCampaignReports operation in CertificationCampaignsApi.
|
|
19522
|
+
* @export
|
|
19523
|
+
* @interface CertificationCampaignsApiGetCampaignReportsRequest
|
|
19524
|
+
*/
|
|
19525
|
+
export interface CertificationCampaignsApiGetCampaignReportsRequest {
|
|
19526
|
+
/**
|
|
19527
|
+
* The ID of the campaign for which reports are being fetched.
|
|
19528
|
+
* @type {string}
|
|
19529
|
+
* @memberof CertificationCampaignsApiGetCampaignReports
|
|
19530
|
+
*/
|
|
19531
|
+
readonly campaignId: string;
|
|
19532
|
+
}
|
|
18767
19533
|
/**
|
|
18768
19534
|
* Request parameters for move operation in CertificationCampaignsApi.
|
|
18769
19535
|
* @export
|
|
@@ -18783,6 +19549,89 @@ export interface CertificationCampaignsApiMoveRequest {
|
|
|
18783
19549
|
*/
|
|
18784
19550
|
readonly adminReviewReassign: AdminReviewReassign;
|
|
18785
19551
|
}
|
|
19552
|
+
/**
|
|
19553
|
+
* Request parameters for setCampaignReportsConfig operation in CertificationCampaignsApi.
|
|
19554
|
+
* @export
|
|
19555
|
+
* @interface CertificationCampaignsApiSetCampaignReportsConfigRequest
|
|
19556
|
+
*/
|
|
19557
|
+
export interface CertificationCampaignsApiSetCampaignReportsConfigRequest {
|
|
19558
|
+
/**
|
|
19559
|
+
* Campaign Report Configuration
|
|
19560
|
+
* @type {CampaignReportsConfig}
|
|
19561
|
+
* @memberof CertificationCampaignsApiSetCampaignReportsConfig
|
|
19562
|
+
*/
|
|
19563
|
+
readonly campaignReportsConfig: CampaignReportsConfig;
|
|
19564
|
+
}
|
|
19565
|
+
/**
|
|
19566
|
+
* Request parameters for startCampaign operation in CertificationCampaignsApi.
|
|
19567
|
+
* @export
|
|
19568
|
+
* @interface CertificationCampaignsApiStartCampaignRequest
|
|
19569
|
+
*/
|
|
19570
|
+
export interface CertificationCampaignsApiStartCampaignRequest {
|
|
19571
|
+
/**
|
|
19572
|
+
* The campaign id
|
|
19573
|
+
* @type {string}
|
|
19574
|
+
* @memberof CertificationCampaignsApiStartCampaign
|
|
19575
|
+
*/
|
|
19576
|
+
readonly id: string;
|
|
19577
|
+
/**
|
|
19578
|
+
* Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
19579
|
+
* @type {ActivateCampaignOptions}
|
|
19580
|
+
* @memberof CertificationCampaignsApiStartCampaign
|
|
19581
|
+
*/
|
|
19582
|
+
readonly activateCampaignOptions?: ActivateCampaignOptions;
|
|
19583
|
+
}
|
|
19584
|
+
/**
|
|
19585
|
+
* Request parameters for startCampaignRemediationScan operation in CertificationCampaignsApi.
|
|
19586
|
+
* @export
|
|
19587
|
+
* @interface CertificationCampaignsApiStartCampaignRemediationScanRequest
|
|
19588
|
+
*/
|
|
19589
|
+
export interface CertificationCampaignsApiStartCampaignRemediationScanRequest {
|
|
19590
|
+
/**
|
|
19591
|
+
* The ID of the campaign for which remediation scan is being run.
|
|
19592
|
+
* @type {string}
|
|
19593
|
+
* @memberof CertificationCampaignsApiStartCampaignRemediationScan
|
|
19594
|
+
*/
|
|
19595
|
+
readonly id: string;
|
|
19596
|
+
}
|
|
19597
|
+
/**
|
|
19598
|
+
* Request parameters for startCampaignReport operation in CertificationCampaignsApi.
|
|
19599
|
+
* @export
|
|
19600
|
+
* @interface CertificationCampaignsApiStartCampaignReportRequest
|
|
19601
|
+
*/
|
|
19602
|
+
export interface CertificationCampaignsApiStartCampaignReportRequest {
|
|
19603
|
+
/**
|
|
19604
|
+
* The ID of the campaign for which report is being run.
|
|
19605
|
+
* @type {string}
|
|
19606
|
+
* @memberof CertificationCampaignsApiStartCampaignReport
|
|
19607
|
+
*/
|
|
19608
|
+
readonly id: string;
|
|
19609
|
+
/**
|
|
19610
|
+
* The type of the report to run.
|
|
19611
|
+
* @type {ReportType}
|
|
19612
|
+
* @memberof CertificationCampaignsApiStartCampaignReport
|
|
19613
|
+
*/
|
|
19614
|
+
readonly type: ReportType;
|
|
19615
|
+
}
|
|
19616
|
+
/**
|
|
19617
|
+
* Request parameters for updateCampaign operation in CertificationCampaignsApi.
|
|
19618
|
+
* @export
|
|
19619
|
+
* @interface CertificationCampaignsApiUpdateCampaignRequest
|
|
19620
|
+
*/
|
|
19621
|
+
export interface CertificationCampaignsApiUpdateCampaignRequest {
|
|
19622
|
+
/**
|
|
19623
|
+
* The ID of the campaign template being modified.
|
|
19624
|
+
* @type {string}
|
|
19625
|
+
* @memberof CertificationCampaignsApiUpdateCampaign
|
|
19626
|
+
*/
|
|
19627
|
+
readonly id: string;
|
|
19628
|
+
/**
|
|
19629
|
+
* A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. In the *STAGED* status, the following fields can be patched: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed In the *ACTIVE* status, the following fields can be patched: * deadline
|
|
19630
|
+
* @type {Array<JsonPatchOperation>}
|
|
19631
|
+
* @memberof CertificationCampaignsApiUpdateCampaign
|
|
19632
|
+
*/
|
|
19633
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
19634
|
+
}
|
|
18786
19635
|
/**
|
|
18787
19636
|
* CertificationCampaignsApi - object-oriented interface
|
|
18788
19637
|
* @export
|
|
@@ -18790,6 +19639,15 @@ export interface CertificationCampaignsApiMoveRequest {
|
|
|
18790
19639
|
* @extends {BaseAPI}
|
|
18791
19640
|
*/
|
|
18792
19641
|
export declare class CertificationCampaignsApi extends BaseAPI {
|
|
19642
|
+
/**
|
|
19643
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Completes a certification campaign. This is provided to admins so that they can complete a certification even if all items have not been completed. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19644
|
+
* @summary Complete a Campaign
|
|
19645
|
+
* @param {CertificationCampaignsApiCompleteCampaignRequest} requestParameters Request parameters.
|
|
19646
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19647
|
+
* @throws {RequiredError}
|
|
19648
|
+
* @memberof CertificationCampaignsApi
|
|
19649
|
+
*/
|
|
19650
|
+
completeCampaign(requestParameters: CertificationCampaignsApiCompleteCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
18793
19651
|
/**
|
|
18794
19652
|
* Creates a new Certification Campaign with the information provided in the request body.
|
|
18795
19653
|
* @summary Create a campaign
|
|
@@ -18798,34 +19656,105 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
18798
19656
|
* @throws {RequiredError}
|
|
18799
19657
|
* @memberof CertificationCampaignsApi
|
|
18800
19658
|
*/
|
|
18801
|
-
createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Campaign, any>>;
|
|
19659
|
+
createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Campaign, any>>;
|
|
19660
|
+
/**
|
|
19661
|
+
* Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
19662
|
+
* @summary Deletes Campaigns
|
|
19663
|
+
* @param {CertificationCampaignsApiDeleteCampaignsRequest} requestParameters Request parameters.
|
|
19664
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19665
|
+
* @throws {RequiredError}
|
|
19666
|
+
* @memberof CertificationCampaignsApi
|
|
19667
|
+
*/
|
|
19668
|
+
deleteCampaigns(requestParameters: CertificationCampaignsApiDeleteCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
19669
|
+
/**
|
|
19670
|
+
* Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.
|
|
19671
|
+
* @summary List Campaigns
|
|
19672
|
+
* @param {CertificationCampaignsApiGetActiveCampaignsRequest} requestParameters Request parameters.
|
|
19673
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19674
|
+
* @throws {RequiredError}
|
|
19675
|
+
* @memberof CertificationCampaignsApi
|
|
19676
|
+
*/
|
|
19677
|
+
getActiveCampaigns(requestParameters?: CertificationCampaignsApiGetActiveCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInner[], any>>;
|
|
19678
|
+
/**
|
|
19679
|
+
* Retrieves information for an existing campaign using the campaign\'s ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.
|
|
19680
|
+
* @summary Get a campaign
|
|
19681
|
+
* @param {CertificationCampaignsApiGetCampaignRequest} requestParameters Request parameters.
|
|
19682
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19683
|
+
* @throws {RequiredError}
|
|
19684
|
+
* @memberof CertificationCampaignsApi
|
|
19685
|
+
*/
|
|
19686
|
+
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SlimCampaign, any>>;
|
|
19687
|
+
/**
|
|
19688
|
+
* Fetches all reports for a certification campaign by campaign ID. Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN
|
|
19689
|
+
* @summary Get Campaign Reports
|
|
19690
|
+
* @param {CertificationCampaignsApiGetCampaignReportsRequest} requestParameters Request parameters.
|
|
19691
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19692
|
+
* @throws {RequiredError}
|
|
19693
|
+
* @memberof CertificationCampaignsApi
|
|
19694
|
+
*/
|
|
19695
|
+
getCampaignReports(requestParameters: CertificationCampaignsApiGetCampaignReportsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReport[], any>>;
|
|
19696
|
+
/**
|
|
19697
|
+
* Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. Requires roles of CERT_ADMIN and ORG_ADMIN.
|
|
19698
|
+
* @summary Get Campaign Reports Configuration
|
|
19699
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19700
|
+
* @throws {RequiredError}
|
|
19701
|
+
* @memberof CertificationCampaignsApi
|
|
19702
|
+
*/
|
|
19703
|
+
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
19704
|
+
/**
|
|
19705
|
+
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
19706
|
+
* @summary Reassign Certifications
|
|
19707
|
+
* @param {CertificationCampaignsApiMoveRequest} requestParameters Request parameters.
|
|
19708
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19709
|
+
* @throws {RequiredError}
|
|
19710
|
+
* @memberof CertificationCampaignsApi
|
|
19711
|
+
*/
|
|
19712
|
+
move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
19713
|
+
/**
|
|
19714
|
+
* Overwrites configuration for campaign reports. Requires roles CERT_ADMIN and ORG_ADMIN.
|
|
19715
|
+
* @summary Set Campaign Reports Configuration
|
|
19716
|
+
* @param {CertificationCampaignsApiSetCampaignReportsConfigRequest} requestParameters Request parameters.
|
|
19717
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19718
|
+
* @throws {RequiredError}
|
|
19719
|
+
* @memberof CertificationCampaignsApi
|
|
19720
|
+
*/
|
|
19721
|
+
setCampaignReportsConfig(requestParameters: CertificationCampaignsApiSetCampaignReportsConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
19722
|
+
/**
|
|
19723
|
+
* Submits a job to activate the campaign with the given Id. The campaign must be staged. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19724
|
+
* @summary Activate a Campaign
|
|
19725
|
+
* @param {CertificationCampaignsApiStartCampaignRequest} requestParameters Request parameters.
|
|
19726
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
19727
|
+
* @throws {RequiredError}
|
|
19728
|
+
* @memberof CertificationCampaignsApi
|
|
19729
|
+
*/
|
|
19730
|
+
startCampaign(requestParameters: CertificationCampaignsApiStartCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
18802
19731
|
/**
|
|
18803
|
-
*
|
|
18804
|
-
* @summary
|
|
18805
|
-
* @param {
|
|
19732
|
+
* Kicks off remediation scan task for a certification campaign. Requires roles of CERT_ADMIN and ORG_ADMIN
|
|
19733
|
+
* @summary Run Campaign Remediation Scan
|
|
19734
|
+
* @param {CertificationCampaignsApiStartCampaignRemediationScanRequest} requestParameters Request parameters.
|
|
18806
19735
|
* @param {*} [axiosOptions] Override http request option.
|
|
18807
19736
|
* @throws {RequiredError}
|
|
18808
19737
|
* @memberof CertificationCampaignsApi
|
|
18809
19738
|
*/
|
|
18810
|
-
|
|
19739
|
+
startCampaignRemediationScan(requestParameters: CertificationCampaignsApiStartCampaignRemediationScanRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
18811
19740
|
/**
|
|
18812
|
-
*
|
|
18813
|
-
* @summary
|
|
18814
|
-
* @param {
|
|
19741
|
+
* Runs a report for a certification campaign. Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.
|
|
19742
|
+
* @summary Run Campaign Report
|
|
19743
|
+
* @param {CertificationCampaignsApiStartCampaignReportRequest} requestParameters Request parameters.
|
|
18815
19744
|
* @param {*} [axiosOptions] Override http request option.
|
|
18816
19745
|
* @throws {RequiredError}
|
|
18817
19746
|
* @memberof CertificationCampaignsApi
|
|
18818
19747
|
*/
|
|
18819
|
-
|
|
19748
|
+
startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
18820
19749
|
/**
|
|
18821
|
-
*
|
|
18822
|
-
* @summary
|
|
18823
|
-
* @param {
|
|
19750
|
+
* Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
19751
|
+
* @summary Update a Campaign
|
|
19752
|
+
* @param {CertificationCampaignsApiUpdateCampaignRequest} requestParameters Request parameters.
|
|
18824
19753
|
* @param {*} [axiosOptions] Override http request option.
|
|
18825
19754
|
* @throws {RequiredError}
|
|
18826
19755
|
* @memberof CertificationCampaignsApi
|
|
18827
19756
|
*/
|
|
18828
|
-
|
|
19757
|
+
updateCampaign(requestParameters: CertificationCampaignsApiUpdateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SlimCampaign, any>>;
|
|
18829
19758
|
}
|
|
18830
19759
|
/**
|
|
18831
19760
|
* CertificationSummariesApi - axios parameter creator
|
|
@@ -19159,6 +20088,14 @@ export declare class CertificationSummariesApi extends BaseAPI {
|
|
|
19159
20088
|
* @export
|
|
19160
20089
|
*/
|
|
19161
20090
|
export declare const CertificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20091
|
+
/**
|
|
20092
|
+
* This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for the specified certification can also call this API.
|
|
20093
|
+
* @summary Certification Task by ID
|
|
20094
|
+
* @param {string} id The task ID
|
|
20095
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20096
|
+
* @throws {RequiredError}
|
|
20097
|
+
*/
|
|
20098
|
+
getCertificationTask: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19162
20099
|
/**
|
|
19163
20100
|
* This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19164
20101
|
* @summary Identity Certification by ID
|
|
@@ -19167,6 +20104,19 @@ export declare const CertificationsApiAxiosParamCreator: (configuration?: Config
|
|
|
19167
20104
|
* @throws {RequiredError}
|
|
19168
20105
|
*/
|
|
19169
20106
|
getIdentityCertification: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20107
|
+
/**
|
|
20108
|
+
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20109
|
+
* @summary List of Reviewers for certification
|
|
20110
|
+
* @param {string} id The certification ID
|
|
20111
|
+
* @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.
|
|
20112
|
+
* @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.
|
|
20113
|
+
* @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.
|
|
20114
|
+
* @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 (Filtering is done by reviewer\'s fields): **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw*
|
|
20115
|
+
* @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, email**
|
|
20116
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20117
|
+
* @throws {RequiredError}
|
|
20118
|
+
*/
|
|
20119
|
+
listCertificationReviewers: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19170
20120
|
/**
|
|
19171
20121
|
* This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19172
20122
|
* @summary List of Access Review Items
|
|
@@ -19228,6 +20178,14 @@ export declare const CertificationsApiAxiosParamCreator: (configuration?: Config
|
|
|
19228
20178
|
* @export
|
|
19229
20179
|
*/
|
|
19230
20180
|
export declare const CertificationsApiFp: (configuration?: Configuration) => {
|
|
20181
|
+
/**
|
|
20182
|
+
* This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for the specified certification can also call this API.
|
|
20183
|
+
* @summary Certification Task by ID
|
|
20184
|
+
* @param {string} id The task ID
|
|
20185
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20186
|
+
* @throws {RequiredError}
|
|
20187
|
+
*/
|
|
20188
|
+
getCertificationTask(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
19231
20189
|
/**
|
|
19232
20190
|
* This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19233
20191
|
* @summary Identity Certification by ID
|
|
@@ -19236,6 +20194,19 @@ export declare const CertificationsApiFp: (configuration?: Configuration) => {
|
|
|
19236
20194
|
* @throws {RequiredError}
|
|
19237
20195
|
*/
|
|
19238
20196
|
getIdentityCertification(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityCertificationDto>>;
|
|
20197
|
+
/**
|
|
20198
|
+
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20199
|
+
* @summary List of Reviewers for certification
|
|
20200
|
+
* @param {string} id The certification ID
|
|
20201
|
+
* @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.
|
|
20202
|
+
* @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.
|
|
20203
|
+
* @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.
|
|
20204
|
+
* @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 (Filtering is done by reviewer\'s fields): **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw*
|
|
20205
|
+
* @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, email**
|
|
20206
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20207
|
+
* @throws {RequiredError}
|
|
20208
|
+
*/
|
|
20209
|
+
listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityReferenceWithNameAndEmail>>>;
|
|
19239
20210
|
/**
|
|
19240
20211
|
* This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19241
20212
|
* @summary List of Access Review Items
|
|
@@ -19297,6 +20268,14 @@ export declare const CertificationsApiFp: (configuration?: Configuration) => {
|
|
|
19297
20268
|
* @export
|
|
19298
20269
|
*/
|
|
19299
20270
|
export declare const CertificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20271
|
+
/**
|
|
20272
|
+
* This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for the specified certification can also call this API.
|
|
20273
|
+
* @summary Certification Task by ID
|
|
20274
|
+
* @param {string} id The task ID
|
|
20275
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20276
|
+
* @throws {RequiredError}
|
|
20277
|
+
*/
|
|
20278
|
+
getCertificationTask(id: string, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
19300
20279
|
/**
|
|
19301
20280
|
* This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19302
20281
|
* @summary Identity Certification by ID
|
|
@@ -19305,6 +20284,19 @@ export declare const CertificationsApiFactory: (configuration?: Configuration, b
|
|
|
19305
20284
|
* @throws {RequiredError}
|
|
19306
20285
|
*/
|
|
19307
20286
|
getIdentityCertification(id: string, axiosOptions?: any): AxiosPromise<IdentityCertificationDto>;
|
|
20287
|
+
/**
|
|
20288
|
+
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20289
|
+
* @summary List of Reviewers for certification
|
|
20290
|
+
* @param {string} id The certification ID
|
|
20291
|
+
* @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.
|
|
20292
|
+
* @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.
|
|
20293
|
+
* @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.
|
|
20294
|
+
* @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 (Filtering is done by reviewer\'s fields): **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw*
|
|
20295
|
+
* @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, email**
|
|
20296
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20297
|
+
* @throws {RequiredError}
|
|
20298
|
+
*/
|
|
20299
|
+
listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityReferenceWithNameAndEmail>>;
|
|
19308
20300
|
/**
|
|
19309
20301
|
* This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19310
20302
|
* @summary List of Access Review Items
|
|
@@ -19361,6 +20353,19 @@ export declare const CertificationsApiFactory: (configuration?: Configuration, b
|
|
|
19361
20353
|
*/
|
|
19362
20354
|
signOffIdentityCertification(id: string, axiosOptions?: any): AxiosPromise<IdentityCertificationDto>;
|
|
19363
20355
|
};
|
|
20356
|
+
/**
|
|
20357
|
+
* Request parameters for getCertificationTask operation in CertificationsApi.
|
|
20358
|
+
* @export
|
|
20359
|
+
* @interface CertificationsApiGetCertificationTaskRequest
|
|
20360
|
+
*/
|
|
20361
|
+
export interface CertificationsApiGetCertificationTaskRequest {
|
|
20362
|
+
/**
|
|
20363
|
+
* The task ID
|
|
20364
|
+
* @type {string}
|
|
20365
|
+
* @memberof CertificationsApiGetCertificationTask
|
|
20366
|
+
*/
|
|
20367
|
+
readonly id: string;
|
|
20368
|
+
}
|
|
19364
20369
|
/**
|
|
19365
20370
|
* Request parameters for getIdentityCertification operation in CertificationsApi.
|
|
19366
20371
|
* @export
|
|
@@ -19374,6 +20379,49 @@ export interface CertificationsApiGetIdentityCertificationRequest {
|
|
|
19374
20379
|
*/
|
|
19375
20380
|
readonly id: string;
|
|
19376
20381
|
}
|
|
20382
|
+
/**
|
|
20383
|
+
* Request parameters for listCertificationReviewers operation in CertificationsApi.
|
|
20384
|
+
* @export
|
|
20385
|
+
* @interface CertificationsApiListCertificationReviewersRequest
|
|
20386
|
+
*/
|
|
20387
|
+
export interface CertificationsApiListCertificationReviewersRequest {
|
|
20388
|
+
/**
|
|
20389
|
+
* The certification ID
|
|
20390
|
+
* @type {string}
|
|
20391
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20392
|
+
*/
|
|
20393
|
+
readonly id: string;
|
|
20394
|
+
/**
|
|
20395
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20396
|
+
* @type {number}
|
|
20397
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20398
|
+
*/
|
|
20399
|
+
readonly limit?: number;
|
|
20400
|
+
/**
|
|
20401
|
+
* 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.
|
|
20402
|
+
* @type {number}
|
|
20403
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20404
|
+
*/
|
|
20405
|
+
readonly offset?: number;
|
|
20406
|
+
/**
|
|
20407
|
+
* 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.
|
|
20408
|
+
* @type {boolean}
|
|
20409
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20410
|
+
*/
|
|
20411
|
+
readonly count?: boolean;
|
|
20412
|
+
/**
|
|
20413
|
+
* 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 (Filtering is done by reviewer\'s fields): **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw*
|
|
20414
|
+
* @type {string}
|
|
20415
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20416
|
+
*/
|
|
20417
|
+
readonly filters?: string;
|
|
20418
|
+
/**
|
|
20419
|
+
* 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, email**
|
|
20420
|
+
* @type {string}
|
|
20421
|
+
* @memberof CertificationsApiListCertificationReviewers
|
|
20422
|
+
*/
|
|
20423
|
+
readonly sorters?: string;
|
|
20424
|
+
}
|
|
19377
20425
|
/**
|
|
19378
20426
|
* Request parameters for listIdentityAccessReviewItems operation in CertificationsApi.
|
|
19379
20427
|
* @export
|
|
@@ -19536,6 +20584,15 @@ export interface CertificationsApiSignOffIdentityCertificationRequest {
|
|
|
19536
20584
|
* @extends {BaseAPI}
|
|
19537
20585
|
*/
|
|
19538
20586
|
export declare class CertificationsApi extends BaseAPI {
|
|
20587
|
+
/**
|
|
20588
|
+
* This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for the specified certification can also call this API.
|
|
20589
|
+
* @summary Certification Task by ID
|
|
20590
|
+
* @param {CertificationsApiGetCertificationTaskRequest} requestParameters Request parameters.
|
|
20591
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20592
|
+
* @throws {RequiredError}
|
|
20593
|
+
* @memberof CertificationsApi
|
|
20594
|
+
*/
|
|
20595
|
+
getCertificationTask(requestParameters: CertificationsApiGetCertificationTaskRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
19539
20596
|
/**
|
|
19540
20597
|
* This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19541
20598
|
* @summary Identity Certification by ID
|
|
@@ -19545,6 +20602,15 @@ export declare class CertificationsApi extends BaseAPI {
|
|
|
19545
20602
|
* @memberof CertificationsApi
|
|
19546
20603
|
*/
|
|
19547
20604
|
getIdentityCertification(requestParameters: CertificationsApiGetIdentityCertificationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityCertificationDto, any>>;
|
|
20605
|
+
/**
|
|
20606
|
+
* This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
20607
|
+
* @summary List of Reviewers for certification
|
|
20608
|
+
* @param {CertificationsApiListCertificationReviewersRequest} requestParameters Request parameters.
|
|
20609
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20610
|
+
* @throws {RequiredError}
|
|
20611
|
+
* @memberof CertificationsApi
|
|
20612
|
+
*/
|
|
20613
|
+
listCertificationReviewers(requestParameters: CertificationsApiListCertificationReviewersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityReferenceWithNameAndEmail[], any>>;
|
|
19548
20614
|
/**
|
|
19549
20615
|
* This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
19550
20616
|
* @summary List of Access Review Items
|
|
@@ -19591,11 +20657,174 @@ export declare class CertificationsApi extends BaseAPI {
|
|
|
19591
20657
|
*/
|
|
19592
20658
|
signOffIdentityCertification(requestParameters: CertificationsApiSignOffIdentityCertificationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityCertificationDto, any>>;
|
|
19593
20659
|
}
|
|
20660
|
+
/**
|
|
20661
|
+
* GlobalTenantSecuritySettingsApi - axios parameter creator
|
|
20662
|
+
* @export
|
|
20663
|
+
*/
|
|
20664
|
+
export declare const GlobalTenantSecuritySettingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20665
|
+
/**
|
|
20666
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:create\'
|
|
20667
|
+
* @summary Create security network configuration.
|
|
20668
|
+
* @param {NetworkConfiguration} networkConfiguration Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20669
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20670
|
+
* @throws {RequiredError}
|
|
20671
|
+
*/
|
|
20672
|
+
createAuthOrgNetworkConfig: (networkConfiguration: NetworkConfiguration, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20673
|
+
/**
|
|
20674
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
20675
|
+
* @summary Get security network configuration.
|
|
20676
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20677
|
+
* @throws {RequiredError}
|
|
20678
|
+
*/
|
|
20679
|
+
getAuthOrgNetworkConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20680
|
+
/**
|
|
20681
|
+
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
20682
|
+
* @summary Update security network configuration.
|
|
20683
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20684
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20685
|
+
* @throws {RequiredError}
|
|
20686
|
+
*/
|
|
20687
|
+
patchAuthOrgNetworkConfig: (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20688
|
+
};
|
|
20689
|
+
/**
|
|
20690
|
+
* GlobalTenantSecuritySettingsApi - functional programming interface
|
|
20691
|
+
* @export
|
|
20692
|
+
*/
|
|
20693
|
+
export declare const GlobalTenantSecuritySettingsApiFp: (configuration?: Configuration) => {
|
|
20694
|
+
/**
|
|
20695
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:create\'
|
|
20696
|
+
* @summary Create security network configuration.
|
|
20697
|
+
* @param {NetworkConfiguration} networkConfiguration Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20698
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20699
|
+
* @throws {RequiredError}
|
|
20700
|
+
*/
|
|
20701
|
+
createAuthOrgNetworkConfig(networkConfiguration: NetworkConfiguration, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
20702
|
+
/**
|
|
20703
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
20704
|
+
* @summary Get security network configuration.
|
|
20705
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20706
|
+
* @throws {RequiredError}
|
|
20707
|
+
*/
|
|
20708
|
+
getAuthOrgNetworkConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
20709
|
+
/**
|
|
20710
|
+
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
20711
|
+
* @summary Update security network configuration.
|
|
20712
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20713
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20714
|
+
* @throws {RequiredError}
|
|
20715
|
+
*/
|
|
20716
|
+
patchAuthOrgNetworkConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
20717
|
+
};
|
|
20718
|
+
/**
|
|
20719
|
+
* GlobalTenantSecuritySettingsApi - factory interface
|
|
20720
|
+
* @export
|
|
20721
|
+
*/
|
|
20722
|
+
export declare const GlobalTenantSecuritySettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20723
|
+
/**
|
|
20724
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:create\'
|
|
20725
|
+
* @summary Create security network configuration.
|
|
20726
|
+
* @param {NetworkConfiguration} networkConfiguration Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20727
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20728
|
+
* @throws {RequiredError}
|
|
20729
|
+
*/
|
|
20730
|
+
createAuthOrgNetworkConfig(networkConfiguration: NetworkConfiguration, axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
20731
|
+
/**
|
|
20732
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
20733
|
+
* @summary Get security network configuration.
|
|
20734
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20735
|
+
* @throws {RequiredError}
|
|
20736
|
+
*/
|
|
20737
|
+
getAuthOrgNetworkConfig(axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
20738
|
+
/**
|
|
20739
|
+
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
20740
|
+
* @summary Update security network configuration.
|
|
20741
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20742
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20743
|
+
* @throws {RequiredError}
|
|
20744
|
+
*/
|
|
20745
|
+
patchAuthOrgNetworkConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
20746
|
+
};
|
|
20747
|
+
/**
|
|
20748
|
+
* Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi.
|
|
20749
|
+
* @export
|
|
20750
|
+
* @interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest
|
|
20751
|
+
*/
|
|
20752
|
+
export interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest {
|
|
20753
|
+
/**
|
|
20754
|
+
* Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20755
|
+
* @type {NetworkConfiguration}
|
|
20756
|
+
* @memberof GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfig
|
|
20757
|
+
*/
|
|
20758
|
+
readonly networkConfiguration: NetworkConfiguration;
|
|
20759
|
+
}
|
|
20760
|
+
/**
|
|
20761
|
+
* Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi.
|
|
20762
|
+
* @export
|
|
20763
|
+
* @interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest
|
|
20764
|
+
*/
|
|
20765
|
+
export interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest {
|
|
20766
|
+
/**
|
|
20767
|
+
* A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
20768
|
+
* @type {Array<JsonPatchOperation>}
|
|
20769
|
+
* @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfig
|
|
20770
|
+
*/
|
|
20771
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
20772
|
+
}
|
|
20773
|
+
/**
|
|
20774
|
+
* GlobalTenantSecuritySettingsApi - object-oriented interface
|
|
20775
|
+
* @export
|
|
20776
|
+
* @class GlobalTenantSecuritySettingsApi
|
|
20777
|
+
* @extends {BaseAPI}
|
|
20778
|
+
*/
|
|
20779
|
+
export declare class GlobalTenantSecuritySettingsApi extends BaseAPI {
|
|
20780
|
+
/**
|
|
20781
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:create\'
|
|
20782
|
+
* @summary Create security network configuration.
|
|
20783
|
+
* @param {GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters.
|
|
20784
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20785
|
+
* @throws {RequiredError}
|
|
20786
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
20787
|
+
*/
|
|
20788
|
+
createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
20789
|
+
/**
|
|
20790
|
+
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
20791
|
+
* @summary Get security network configuration.
|
|
20792
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20793
|
+
* @throws {RequiredError}
|
|
20794
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
20795
|
+
*/
|
|
20796
|
+
getAuthOrgNetworkConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
20797
|
+
/**
|
|
20798
|
+
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
20799
|
+
* @summary Update security network configuration.
|
|
20800
|
+
* @param {GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters.
|
|
20801
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20802
|
+
* @throws {RequiredError}
|
|
20803
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
20804
|
+
*/
|
|
20805
|
+
patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
20806
|
+
}
|
|
19594
20807
|
/**
|
|
19595
20808
|
* IdentityProfilesApi - axios parameter creator
|
|
19596
20809
|
* @export
|
|
19597
20810
|
*/
|
|
19598
20811
|
export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20812
|
+
/**
|
|
20813
|
+
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20814
|
+
* @summary Delete an Identity Profile
|
|
20815
|
+
* @param {string} identityProfileId The Identity Profile ID.
|
|
20816
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20817
|
+
* @throws {RequiredError}
|
|
20818
|
+
*/
|
|
20819
|
+
deleteIdentityProfile: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20820
|
+
/**
|
|
20821
|
+
* This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20822
|
+
* @summary Delete Identity Profiles
|
|
20823
|
+
* @param {Array<string>} requestBody Identity Profile bulk delete request body.
|
|
20824
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20825
|
+
* @throws {RequiredError}
|
|
20826
|
+
*/
|
|
20827
|
+
deleteIdentityProfiles: (requestBody: Array<string>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19599
20828
|
/**
|
|
19600
20829
|
* This exports existing identity profiles in the format specified by the sp-config service.
|
|
19601
20830
|
* @summary Export Identity Profiles
|
|
@@ -19644,12 +20873,36 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
19644
20873
|
* @throws {RequiredError}
|
|
19645
20874
|
*/
|
|
19646
20875
|
listIdentityProfiles: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20876
|
+
/**
|
|
20877
|
+
* Process identities under the profile A token with ORG_ADMIN authority is required to call this API.
|
|
20878
|
+
* @summary Process identities under profile
|
|
20879
|
+
* @param {string} identityProfileId The Identity Profile ID to be processed
|
|
20880
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20881
|
+
* @throws {RequiredError}
|
|
20882
|
+
*/
|
|
20883
|
+
syncIdentityProfile: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
19647
20884
|
};
|
|
19648
20885
|
/**
|
|
19649
20886
|
* IdentityProfilesApi - functional programming interface
|
|
19650
20887
|
* @export
|
|
19651
20888
|
*/
|
|
19652
20889
|
export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
20890
|
+
/**
|
|
20891
|
+
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20892
|
+
* @summary Delete an Identity Profile
|
|
20893
|
+
* @param {string} identityProfileId The Identity Profile ID.
|
|
20894
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20895
|
+
* @throws {RequiredError}
|
|
20896
|
+
*/
|
|
20897
|
+
deleteIdentityProfile(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultSimplified>>;
|
|
20898
|
+
/**
|
|
20899
|
+
* This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20900
|
+
* @summary Delete Identity Profiles
|
|
20901
|
+
* @param {Array<string>} requestBody Identity Profile bulk delete request body.
|
|
20902
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20903
|
+
* @throws {RequiredError}
|
|
20904
|
+
*/
|
|
20905
|
+
deleteIdentityProfiles(requestBody: Array<string>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultSimplified>>;
|
|
19653
20906
|
/**
|
|
19654
20907
|
* This exports existing identity profiles in the format specified by the sp-config service.
|
|
19655
20908
|
* @summary Export Identity Profiles
|
|
@@ -19698,12 +20951,36 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
19698
20951
|
* @throws {RequiredError}
|
|
19699
20952
|
*/
|
|
19700
20953
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityProfile>>>;
|
|
20954
|
+
/**
|
|
20955
|
+
* Process identities under the profile A token with ORG_ADMIN authority is required to call this API.
|
|
20956
|
+
* @summary Process identities under profile
|
|
20957
|
+
* @param {string} identityProfileId The Identity Profile ID to be processed
|
|
20958
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20959
|
+
* @throws {RequiredError}
|
|
20960
|
+
*/
|
|
20961
|
+
syncIdentityProfile(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
19701
20962
|
};
|
|
19702
20963
|
/**
|
|
19703
20964
|
* IdentityProfilesApi - factory interface
|
|
19704
20965
|
* @export
|
|
19705
20966
|
*/
|
|
19706
20967
|
export declare const IdentityProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20968
|
+
/**
|
|
20969
|
+
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20970
|
+
* @summary Delete an Identity Profile
|
|
20971
|
+
* @param {string} identityProfileId The Identity Profile ID.
|
|
20972
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20973
|
+
* @throws {RequiredError}
|
|
20974
|
+
*/
|
|
20975
|
+
deleteIdentityProfile(identityProfileId: string, axiosOptions?: any): AxiosPromise<TaskResultSimplified>;
|
|
20976
|
+
/**
|
|
20977
|
+
* This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
20978
|
+
* @summary Delete Identity Profiles
|
|
20979
|
+
* @param {Array<string>} requestBody Identity Profile bulk delete request body.
|
|
20980
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20981
|
+
* @throws {RequiredError}
|
|
20982
|
+
*/
|
|
20983
|
+
deleteIdentityProfiles(requestBody: Array<string>, axiosOptions?: any): AxiosPromise<TaskResultSimplified>;
|
|
19707
20984
|
/**
|
|
19708
20985
|
* This exports existing identity profiles in the format specified by the sp-config service.
|
|
19709
20986
|
* @summary Export Identity Profiles
|
|
@@ -19752,7 +21029,41 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
19752
21029
|
* @throws {RequiredError}
|
|
19753
21030
|
*/
|
|
19754
21031
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfile>>;
|
|
21032
|
+
/**
|
|
21033
|
+
* Process identities under the profile A token with ORG_ADMIN authority is required to call this API.
|
|
21034
|
+
* @summary Process identities under profile
|
|
21035
|
+
* @param {string} identityProfileId The Identity Profile ID to be processed
|
|
21036
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21037
|
+
* @throws {RequiredError}
|
|
21038
|
+
*/
|
|
21039
|
+
syncIdentityProfile(identityProfileId: string, axiosOptions?: any): AxiosPromise<object>;
|
|
19755
21040
|
};
|
|
21041
|
+
/**
|
|
21042
|
+
* Request parameters for deleteIdentityProfile operation in IdentityProfilesApi.
|
|
21043
|
+
* @export
|
|
21044
|
+
* @interface IdentityProfilesApiDeleteIdentityProfileRequest
|
|
21045
|
+
*/
|
|
21046
|
+
export interface IdentityProfilesApiDeleteIdentityProfileRequest {
|
|
21047
|
+
/**
|
|
21048
|
+
* The Identity Profile ID.
|
|
21049
|
+
* @type {string}
|
|
21050
|
+
* @memberof IdentityProfilesApiDeleteIdentityProfile
|
|
21051
|
+
*/
|
|
21052
|
+
readonly identityProfileId: string;
|
|
21053
|
+
}
|
|
21054
|
+
/**
|
|
21055
|
+
* Request parameters for deleteIdentityProfiles operation in IdentityProfilesApi.
|
|
21056
|
+
* @export
|
|
21057
|
+
* @interface IdentityProfilesApiDeleteIdentityProfilesRequest
|
|
21058
|
+
*/
|
|
21059
|
+
export interface IdentityProfilesApiDeleteIdentityProfilesRequest {
|
|
21060
|
+
/**
|
|
21061
|
+
* Identity Profile bulk delete request body.
|
|
21062
|
+
* @type {Array<string>}
|
|
21063
|
+
* @memberof IdentityProfilesApiDeleteIdentityProfiles
|
|
21064
|
+
*/
|
|
21065
|
+
readonly requestBody: Array<string>;
|
|
21066
|
+
}
|
|
19756
21067
|
/**
|
|
19757
21068
|
* Request parameters for exportIdentityProfiles operation in IdentityProfilesApi.
|
|
19758
21069
|
* @export
|
|
@@ -19866,6 +21177,19 @@ export interface IdentityProfilesApiListIdentityProfilesRequest {
|
|
|
19866
21177
|
*/
|
|
19867
21178
|
readonly sorters?: string;
|
|
19868
21179
|
}
|
|
21180
|
+
/**
|
|
21181
|
+
* Request parameters for syncIdentityProfile operation in IdentityProfilesApi.
|
|
21182
|
+
* @export
|
|
21183
|
+
* @interface IdentityProfilesApiSyncIdentityProfileRequest
|
|
21184
|
+
*/
|
|
21185
|
+
export interface IdentityProfilesApiSyncIdentityProfileRequest {
|
|
21186
|
+
/**
|
|
21187
|
+
* The Identity Profile ID to be processed
|
|
21188
|
+
* @type {string}
|
|
21189
|
+
* @memberof IdentityProfilesApiSyncIdentityProfile
|
|
21190
|
+
*/
|
|
21191
|
+
readonly identityProfileId: string;
|
|
21192
|
+
}
|
|
19869
21193
|
/**
|
|
19870
21194
|
* IdentityProfilesApi - object-oriented interface
|
|
19871
21195
|
* @export
|
|
@@ -19873,6 +21197,24 @@ export interface IdentityProfilesApiListIdentityProfilesRequest {
|
|
|
19873
21197
|
* @extends {BaseAPI}
|
|
19874
21198
|
*/
|
|
19875
21199
|
export declare class IdentityProfilesApi extends BaseAPI {
|
|
21200
|
+
/**
|
|
21201
|
+
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
21202
|
+
* @summary Delete an Identity Profile
|
|
21203
|
+
* @param {IdentityProfilesApiDeleteIdentityProfileRequest} requestParameters Request parameters.
|
|
21204
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21205
|
+
* @throws {RequiredError}
|
|
21206
|
+
* @memberof IdentityProfilesApi
|
|
21207
|
+
*/
|
|
21208
|
+
deleteIdentityProfile(requestParameters: IdentityProfilesApiDeleteIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskResultSimplified, any>>;
|
|
21209
|
+
/**
|
|
21210
|
+
* This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
21211
|
+
* @summary Delete Identity Profiles
|
|
21212
|
+
* @param {IdentityProfilesApiDeleteIdentityProfilesRequest} requestParameters Request parameters.
|
|
21213
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21214
|
+
* @throws {RequiredError}
|
|
21215
|
+
* @memberof IdentityProfilesApi
|
|
21216
|
+
*/
|
|
21217
|
+
deleteIdentityProfiles(requestParameters: IdentityProfilesApiDeleteIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskResultSimplified, any>>;
|
|
19876
21218
|
/**
|
|
19877
21219
|
* This exports existing identity profiles in the format specified by the sp-config service.
|
|
19878
21220
|
* @summary Export Identity Profiles
|
|
@@ -19918,6 +21260,15 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
19918
21260
|
* @memberof IdentityProfilesApi
|
|
19919
21261
|
*/
|
|
19920
21262
|
listIdentityProfiles(requestParameters?: IdentityProfilesApiListIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfile[], any>>;
|
|
21263
|
+
/**
|
|
21264
|
+
* Process identities under the profile A token with ORG_ADMIN authority is required to call this API.
|
|
21265
|
+
* @summary Process identities under profile
|
|
21266
|
+
* @param {IdentityProfilesApiSyncIdentityProfileRequest} requestParameters Request parameters.
|
|
21267
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21268
|
+
* @throws {RequiredError}
|
|
21269
|
+
* @memberof IdentityProfilesApi
|
|
21270
|
+
*/
|
|
21271
|
+
syncIdentityProfile(requestParameters: IdentityProfilesApiSyncIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
19921
21272
|
}
|
|
19922
21273
|
/**
|
|
19923
21274
|
* LifecycleStatesApi - axios parameter creator
|
|
@@ -22359,7 +23710,7 @@ export declare class OAuthClientsApi extends BaseAPI {
|
|
|
22359
23710
|
*/
|
|
22360
23711
|
export declare const PasswordConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22361
23712
|
/**
|
|
22362
|
-
* 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\'
|
|
23713
|
+
* This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22363
23714
|
* @summary Create Password Org Config
|
|
22364
23715
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22365
23716
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22374,13 +23725,13 @@ export declare const PasswordConfigurationApiAxiosParamCreator: (configuration?:
|
|
|
22374
23725
|
*/
|
|
22375
23726
|
getPasswordOrgConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22376
23727
|
/**
|
|
22377
|
-
* 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\'
|
|
23728
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22378
23729
|
* @summary Update Password Org Config
|
|
22379
23730
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22380
23731
|
* @param {*} [axiosOptions] Override http request option.
|
|
22381
23732
|
* @throws {RequiredError}
|
|
22382
23733
|
*/
|
|
22383
|
-
|
|
23734
|
+
putPasswordOrgConfig: (passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22384
23735
|
};
|
|
22385
23736
|
/**
|
|
22386
23737
|
* PasswordConfigurationApi - functional programming interface
|
|
@@ -22388,7 +23739,7 @@ export declare const PasswordConfigurationApiAxiosParamCreator: (configuration?:
|
|
|
22388
23739
|
*/
|
|
22389
23740
|
export declare const PasswordConfigurationApiFp: (configuration?: Configuration) => {
|
|
22390
23741
|
/**
|
|
22391
|
-
* 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\'
|
|
23742
|
+
* This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22392
23743
|
* @summary Create Password Org Config
|
|
22393
23744
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22394
23745
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22403,13 +23754,13 @@ export declare const PasswordConfigurationApiFp: (configuration?: Configuration)
|
|
|
22403
23754
|
*/
|
|
22404
23755
|
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
22405
23756
|
/**
|
|
22406
|
-
* 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\'
|
|
23757
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22407
23758
|
* @summary Update Password Org Config
|
|
22408
23759
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22409
23760
|
* @param {*} [axiosOptions] Override http request option.
|
|
22410
23761
|
* @throws {RequiredError}
|
|
22411
23762
|
*/
|
|
22412
|
-
|
|
23763
|
+
putPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
22413
23764
|
};
|
|
22414
23765
|
/**
|
|
22415
23766
|
* PasswordConfigurationApi - factory interface
|
|
@@ -22417,7 +23768,7 @@ export declare const PasswordConfigurationApiFp: (configuration?: Configuration)
|
|
|
22417
23768
|
*/
|
|
22418
23769
|
export declare const PasswordConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
22419
23770
|
/**
|
|
22420
|
-
* 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\'
|
|
23771
|
+
* This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22421
23772
|
* @summary Create Password Org Config
|
|
22422
23773
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22423
23774
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22432,13 +23783,13 @@ export declare const PasswordConfigurationApiFactory: (configuration?: Configura
|
|
|
22432
23783
|
*/
|
|
22433
23784
|
getPasswordOrgConfig(axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
22434
23785
|
/**
|
|
22435
|
-
* 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\'
|
|
23786
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22436
23787
|
* @summary Update Password Org Config
|
|
22437
23788
|
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
22438
23789
|
* @param {*} [axiosOptions] Override http request option.
|
|
22439
23790
|
* @throws {RequiredError}
|
|
22440
23791
|
*/
|
|
22441
|
-
|
|
23792
|
+
putPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
22442
23793
|
};
|
|
22443
23794
|
/**
|
|
22444
23795
|
* Request parameters for createPasswordOrgConfig operation in PasswordConfigurationApi.
|
|
@@ -22454,15 +23805,15 @@ export interface PasswordConfigurationApiCreatePasswordOrgConfigRequest {
|
|
|
22454
23805
|
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
22455
23806
|
}
|
|
22456
23807
|
/**
|
|
22457
|
-
* Request parameters for
|
|
23808
|
+
* Request parameters for putPasswordOrgConfig operation in PasswordConfigurationApi.
|
|
22458
23809
|
* @export
|
|
22459
|
-
* @interface
|
|
23810
|
+
* @interface PasswordConfigurationApiPutPasswordOrgConfigRequest
|
|
22460
23811
|
*/
|
|
22461
|
-
export interface
|
|
23812
|
+
export interface PasswordConfigurationApiPutPasswordOrgConfigRequest {
|
|
22462
23813
|
/**
|
|
22463
23814
|
*
|
|
22464
23815
|
* @type {PasswordOrgConfig}
|
|
22465
|
-
* @memberof
|
|
23816
|
+
* @memberof PasswordConfigurationApiPutPasswordOrgConfig
|
|
22466
23817
|
*/
|
|
22467
23818
|
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
22468
23819
|
}
|
|
@@ -22474,7 +23825,7 @@ export interface PasswordConfigurationApiUpdatePasswordOrgConfigRequest {
|
|
|
22474
23825
|
*/
|
|
22475
23826
|
export declare class PasswordConfigurationApi extends BaseAPI {
|
|
22476
23827
|
/**
|
|
22477
|
-
* 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\'
|
|
23828
|
+
* This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22478
23829
|
* @summary Create Password Org Config
|
|
22479
23830
|
* @param {PasswordConfigurationApiCreatePasswordOrgConfigRequest} requestParameters Request parameters.
|
|
22480
23831
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22491,14 +23842,14 @@ export declare class PasswordConfigurationApi extends BaseAPI {
|
|
|
22491
23842
|
*/
|
|
22492
23843
|
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
22493
23844
|
/**
|
|
22494
|
-
* 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\'
|
|
23845
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
22495
23846
|
* @summary Update Password Org Config
|
|
22496
|
-
* @param {
|
|
23847
|
+
* @param {PasswordConfigurationApiPutPasswordOrgConfigRequest} requestParameters Request parameters.
|
|
22497
23848
|
* @param {*} [axiosOptions] Override http request option.
|
|
22498
23849
|
* @throws {RequiredError}
|
|
22499
23850
|
* @memberof PasswordConfigurationApi
|
|
22500
23851
|
*/
|
|
22501
|
-
|
|
23852
|
+
putPasswordOrgConfig(requestParameters: PasswordConfigurationApiPutPasswordOrgConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
22502
23853
|
}
|
|
22503
23854
|
/**
|
|
22504
23855
|
* PasswordDictionaryApi - axios parameter creator
|
|
@@ -23644,7 +24995,7 @@ export declare class RequestableObjectsApi extends BaseAPI {
|
|
|
23644
24995
|
*/
|
|
23645
24996
|
export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23646
24997
|
/**
|
|
23647
|
-
* This API creates a
|
|
24998
|
+
* This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. 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.
|
|
23648
24999
|
* @summary Create a Role
|
|
23649
25000
|
* @param {Role} role
|
|
23650
25001
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23703,7 +25054,7 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
23703
25054
|
*/
|
|
23704
25055
|
export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
23705
25056
|
/**
|
|
23706
|
-
* This API creates a
|
|
25057
|
+
* This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. 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.
|
|
23707
25058
|
* @summary Create a Role
|
|
23708
25059
|
* @param {Role} role
|
|
23709
25060
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23762,7 +25113,7 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
23762
25113
|
*/
|
|
23763
25114
|
export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23764
25115
|
/**
|
|
23765
|
-
* This API creates a
|
|
25116
|
+
* This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. 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.
|
|
23766
25117
|
* @summary Create a Role
|
|
23767
25118
|
* @param {Role} role
|
|
23768
25119
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23966,7 +25317,7 @@ export interface RolesApiPatchRoleRequest {
|
|
|
23966
25317
|
*/
|
|
23967
25318
|
export declare class RolesApi extends BaseAPI {
|
|
23968
25319
|
/**
|
|
23969
|
-
* This API creates a
|
|
25320
|
+
* This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. 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.
|
|
23970
25321
|
* @summary Create a Role
|
|
23971
25322
|
* @param {RolesApiCreateRoleRequest} requestParameters Request parameters.
|
|
23972
25323
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25965,7 +27316,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
25965
27316
|
*/
|
|
25966
27317
|
export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25967
27318
|
/**
|
|
25968
|
-
* This API creates a segment. Note
|
|
27319
|
+
* This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
25969
27320
|
* @summary Create Segment
|
|
25970
27321
|
* @param {Segment} segment
|
|
25971
27322
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25973,23 +27324,23 @@ export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
25973
27324
|
*/
|
|
25974
27325
|
createSegment: (segment: Segment, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25975
27326
|
/**
|
|
25976
|
-
* This API deletes the segment specified by the given ID.
|
|
27327
|
+
* This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. A token with ORG_ADMIN or API authority is required to call this API.
|
|
25977
27328
|
* @summary Delete Segment by ID
|
|
25978
|
-
* @param {string} id The ID
|
|
27329
|
+
* @param {string} id The segment ID to delete.
|
|
25979
27330
|
* @param {*} [axiosOptions] Override http request option.
|
|
25980
27331
|
* @throws {RequiredError}
|
|
25981
27332
|
*/
|
|
25982
27333
|
deleteSegment: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25983
27334
|
/**
|
|
25984
|
-
* This API returns the segment specified by the given ID.
|
|
25985
|
-
* @summary Get
|
|
25986
|
-
* @param {string} id The ID
|
|
27335
|
+
* This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27336
|
+
* @summary Get Segment by ID
|
|
27337
|
+
* @param {string} id The segment ID to retrieve.
|
|
25987
27338
|
* @param {*} [axiosOptions] Override http request option.
|
|
25988
27339
|
* @throws {RequiredError}
|
|
25989
27340
|
*/
|
|
25990
27341
|
getSegment: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25991
27342
|
/**
|
|
25992
|
-
* This API returns a list of all segments.
|
|
27343
|
+
* This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.
|
|
25993
27344
|
* @summary List Segments
|
|
25994
27345
|
* @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.
|
|
25995
27346
|
* @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.
|
|
@@ -25999,10 +27350,10 @@ export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
25999
27350
|
*/
|
|
26000
27351
|
listSegments: (limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26001
27352
|
/**
|
|
26002
|
-
*
|
|
26003
|
-
* @summary Update
|
|
26004
|
-
* @param {string} id The ID
|
|
26005
|
-
* @param {Array<object>} requestBody A list of
|
|
27353
|
+
* Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27354
|
+
* @summary Update Segment
|
|
27355
|
+
* @param {string} id The segment ID to modify.
|
|
27356
|
+
* @param {Array<object>} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
|
|
26006
27357
|
* @param {*} [axiosOptions] Override http request option.
|
|
26007
27358
|
* @throws {RequiredError}
|
|
26008
27359
|
*/
|
|
@@ -26014,7 +27365,7 @@ export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
26014
27365
|
*/
|
|
26015
27366
|
export declare const SegmentsApiFp: (configuration?: Configuration) => {
|
|
26016
27367
|
/**
|
|
26017
|
-
* This API creates a segment. Note
|
|
27368
|
+
* This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26018
27369
|
* @summary Create Segment
|
|
26019
27370
|
* @param {Segment} segment
|
|
26020
27371
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26022,23 +27373,23 @@ export declare const SegmentsApiFp: (configuration?: Configuration) => {
|
|
|
26022
27373
|
*/
|
|
26023
27374
|
createSegment(segment: Segment, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Segment>>;
|
|
26024
27375
|
/**
|
|
26025
|
-
* This API deletes the segment specified by the given ID.
|
|
27376
|
+
* This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26026
27377
|
* @summary Delete Segment by ID
|
|
26027
|
-
* @param {string} id The ID
|
|
27378
|
+
* @param {string} id The segment ID to delete.
|
|
26028
27379
|
* @param {*} [axiosOptions] Override http request option.
|
|
26029
27380
|
* @throws {RequiredError}
|
|
26030
27381
|
*/
|
|
26031
27382
|
deleteSegment(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
26032
27383
|
/**
|
|
26033
|
-
* This API returns the segment specified by the given ID.
|
|
26034
|
-
* @summary Get
|
|
26035
|
-
* @param {string} id The ID
|
|
27384
|
+
* This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27385
|
+
* @summary Get Segment by ID
|
|
27386
|
+
* @param {string} id The segment ID to retrieve.
|
|
26036
27387
|
* @param {*} [axiosOptions] Override http request option.
|
|
26037
27388
|
* @throws {RequiredError}
|
|
26038
27389
|
*/
|
|
26039
27390
|
getSegment(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Segment>>;
|
|
26040
27391
|
/**
|
|
26041
|
-
* This API returns a list of all segments.
|
|
27392
|
+
* This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26042
27393
|
* @summary List Segments
|
|
26043
27394
|
* @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.
|
|
26044
27395
|
* @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.
|
|
@@ -26048,10 +27399,10 @@ export declare const SegmentsApiFp: (configuration?: Configuration) => {
|
|
|
26048
27399
|
*/
|
|
26049
27400
|
listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Segment>>>;
|
|
26050
27401
|
/**
|
|
26051
|
-
*
|
|
26052
|
-
* @summary Update
|
|
26053
|
-
* @param {string} id The ID
|
|
26054
|
-
* @param {Array<object>} requestBody A list of
|
|
27402
|
+
* Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27403
|
+
* @summary Update Segment
|
|
27404
|
+
* @param {string} id The segment ID to modify.
|
|
27405
|
+
* @param {Array<object>} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
|
|
26055
27406
|
* @param {*} [axiosOptions] Override http request option.
|
|
26056
27407
|
* @throws {RequiredError}
|
|
26057
27408
|
*/
|
|
@@ -26063,7 +27414,7 @@ export declare const SegmentsApiFp: (configuration?: Configuration) => {
|
|
|
26063
27414
|
*/
|
|
26064
27415
|
export declare const SegmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
26065
27416
|
/**
|
|
26066
|
-
* This API creates a segment. Note
|
|
27417
|
+
* This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26067
27418
|
* @summary Create Segment
|
|
26068
27419
|
* @param {Segment} segment
|
|
26069
27420
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26071,23 +27422,23 @@ export declare const SegmentsApiFactory: (configuration?: Configuration, basePat
|
|
|
26071
27422
|
*/
|
|
26072
27423
|
createSegment(segment: Segment, axiosOptions?: any): AxiosPromise<Segment>;
|
|
26073
27424
|
/**
|
|
26074
|
-
* This API deletes the segment specified by the given ID.
|
|
27425
|
+
* This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26075
27426
|
* @summary Delete Segment by ID
|
|
26076
|
-
* @param {string} id The ID
|
|
27427
|
+
* @param {string} id The segment ID to delete.
|
|
26077
27428
|
* @param {*} [axiosOptions] Override http request option.
|
|
26078
27429
|
* @throws {RequiredError}
|
|
26079
27430
|
*/
|
|
26080
27431
|
deleteSegment(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
26081
27432
|
/**
|
|
26082
|
-
* This API returns the segment specified by the given ID.
|
|
26083
|
-
* @summary Get
|
|
26084
|
-
* @param {string} id The ID
|
|
27433
|
+
* This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27434
|
+
* @summary Get Segment by ID
|
|
27435
|
+
* @param {string} id The segment ID to retrieve.
|
|
26085
27436
|
* @param {*} [axiosOptions] Override http request option.
|
|
26086
27437
|
* @throws {RequiredError}
|
|
26087
27438
|
*/
|
|
26088
27439
|
getSegment(id: string, axiosOptions?: any): AxiosPromise<Segment>;
|
|
26089
27440
|
/**
|
|
26090
|
-
* This API returns a list of all segments.
|
|
27441
|
+
* This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26091
27442
|
* @summary List Segments
|
|
26092
27443
|
* @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.
|
|
26093
27444
|
* @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.
|
|
@@ -26097,10 +27448,10 @@ export declare const SegmentsApiFactory: (configuration?: Configuration, basePat
|
|
|
26097
27448
|
*/
|
|
26098
27449
|
listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<Segment>>;
|
|
26099
27450
|
/**
|
|
26100
|
-
*
|
|
26101
|
-
* @summary Update
|
|
26102
|
-
* @param {string} id The ID
|
|
26103
|
-
* @param {Array<object>} requestBody A list of
|
|
27451
|
+
* Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27452
|
+
* @summary Update Segment
|
|
27453
|
+
* @param {string} id The segment ID to modify.
|
|
27454
|
+
* @param {Array<object>} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
|
|
26104
27455
|
* @param {*} [axiosOptions] Override http request option.
|
|
26105
27456
|
* @throws {RequiredError}
|
|
26106
27457
|
*/
|
|
@@ -26126,7 +27477,7 @@ export interface SegmentsApiCreateSegmentRequest {
|
|
|
26126
27477
|
*/
|
|
26127
27478
|
export interface SegmentsApiDeleteSegmentRequest {
|
|
26128
27479
|
/**
|
|
26129
|
-
* The ID
|
|
27480
|
+
* The segment ID to delete.
|
|
26130
27481
|
* @type {string}
|
|
26131
27482
|
* @memberof SegmentsApiDeleteSegment
|
|
26132
27483
|
*/
|
|
@@ -26139,7 +27490,7 @@ export interface SegmentsApiDeleteSegmentRequest {
|
|
|
26139
27490
|
*/
|
|
26140
27491
|
export interface SegmentsApiGetSegmentRequest {
|
|
26141
27492
|
/**
|
|
26142
|
-
* The ID
|
|
27493
|
+
* The segment ID to retrieve.
|
|
26143
27494
|
* @type {string}
|
|
26144
27495
|
* @memberof SegmentsApiGetSegment
|
|
26145
27496
|
*/
|
|
@@ -26177,13 +27528,13 @@ export interface SegmentsApiListSegmentsRequest {
|
|
|
26177
27528
|
*/
|
|
26178
27529
|
export interface SegmentsApiPatchSegmentRequest {
|
|
26179
27530
|
/**
|
|
26180
|
-
* The ID
|
|
27531
|
+
* The segment ID to modify.
|
|
26181
27532
|
* @type {string}
|
|
26182
27533
|
* @memberof SegmentsApiPatchSegment
|
|
26183
27534
|
*/
|
|
26184
27535
|
readonly id: string;
|
|
26185
27536
|
/**
|
|
26186
|
-
* A list of
|
|
27537
|
+
* A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
|
|
26187
27538
|
* @type {Array<object>}
|
|
26188
27539
|
* @memberof SegmentsApiPatchSegment
|
|
26189
27540
|
*/
|
|
@@ -26197,7 +27548,7 @@ export interface SegmentsApiPatchSegmentRequest {
|
|
|
26197
27548
|
*/
|
|
26198
27549
|
export declare class SegmentsApi extends BaseAPI {
|
|
26199
27550
|
/**
|
|
26200
|
-
* This API creates a segment. Note
|
|
27551
|
+
* This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26201
27552
|
* @summary Create Segment
|
|
26202
27553
|
* @param {SegmentsApiCreateSegmentRequest} requestParameters Request parameters.
|
|
26203
27554
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26206,7 +27557,7 @@ export declare class SegmentsApi extends BaseAPI {
|
|
|
26206
27557
|
*/
|
|
26207
27558
|
createSegment(requestParameters: SegmentsApiCreateSegmentRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Segment, any>>;
|
|
26208
27559
|
/**
|
|
26209
|
-
* This API deletes the segment specified by the given ID.
|
|
27560
|
+
* This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26210
27561
|
* @summary Delete Segment by ID
|
|
26211
27562
|
* @param {SegmentsApiDeleteSegmentRequest} requestParameters Request parameters.
|
|
26212
27563
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26215,8 +27566,8 @@ export declare class SegmentsApi extends BaseAPI {
|
|
|
26215
27566
|
*/
|
|
26216
27567
|
deleteSegment(requestParameters: SegmentsApiDeleteSegmentRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26217
27568
|
/**
|
|
26218
|
-
* This API returns the segment specified by the given ID.
|
|
26219
|
-
* @summary Get
|
|
27569
|
+
* This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27570
|
+
* @summary Get Segment by ID
|
|
26220
27571
|
* @param {SegmentsApiGetSegmentRequest} requestParameters Request parameters.
|
|
26221
27572
|
* @param {*} [axiosOptions] Override http request option.
|
|
26222
27573
|
* @throws {RequiredError}
|
|
@@ -26224,7 +27575,7 @@ export declare class SegmentsApi extends BaseAPI {
|
|
|
26224
27575
|
*/
|
|
26225
27576
|
getSegment(requestParameters: SegmentsApiGetSegmentRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Segment, any>>;
|
|
26226
27577
|
/**
|
|
26227
|
-
* This API returns a list of all segments.
|
|
27578
|
+
* This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API.
|
|
26228
27579
|
* @summary List Segments
|
|
26229
27580
|
* @param {SegmentsApiListSegmentsRequest} requestParameters Request parameters.
|
|
26230
27581
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26233,8 +27584,8 @@ export declare class SegmentsApi extends BaseAPI {
|
|
|
26233
27584
|
*/
|
|
26234
27585
|
listSegments(requestParameters?: SegmentsApiListSegmentsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Segment[], any>>;
|
|
26235
27586
|
/**
|
|
26236
|
-
*
|
|
26237
|
-
* @summary Update
|
|
27587
|
+
* Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.
|
|
27588
|
+
* @summary Update Segment
|
|
26238
27589
|
* @param {SegmentsApiPatchSegmentRequest} requestParameters Request parameters.
|
|
26239
27590
|
* @param {*} [axiosOptions] Override http request option.
|
|
26240
27591
|
* @throws {RequiredError}
|
|
@@ -26784,7 +28135,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
26784
28135
|
* Deletes the provisioning policy with the specified usage on an application. A token with API, or ORG_ADMIN authority is required to call this API.
|
|
26785
28136
|
* @summary Delete Provisioning Policy by UsageType
|
|
26786
28137
|
* @param {string} sourceId The Source ID.
|
|
26787
|
-
* @param {UsageType} usageType The type of
|
|
28138
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
26788
28139
|
* @param {*} [axiosOptions] Override http request option.
|
|
26789
28140
|
* @throws {RequiredError}
|
|
26790
28141
|
*/
|
|
@@ -26827,7 +28178,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
26827
28178
|
* This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
26828
28179
|
* @summary Get Provisioning Policy by UsageType
|
|
26829
28180
|
* @param {string} sourceId The Source ID.
|
|
26830
|
-
* @param {UsageType} usageType The type of
|
|
28181
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
26831
28182
|
* @param {*} [axiosOptions] Override http request option.
|
|
26832
28183
|
* @throws {RequiredError}
|
|
26833
28184
|
*/
|
|
@@ -26919,7 +28270,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
26919
28270
|
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
26920
28271
|
* @summary Update Provisioning Policy by UsageType
|
|
26921
28272
|
* @param {string} sourceId The Source ID.
|
|
26922
|
-
* @param {UsageType} usageType The type of
|
|
28273
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
26923
28274
|
* @param {ProvisioningPolicyDto} provisioningPolicyDto
|
|
26924
28275
|
* @param {*} [axiosOptions] Override http request option.
|
|
26925
28276
|
* @throws {RequiredError}
|
|
@@ -26957,7 +28308,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
26957
28308
|
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
26958
28309
|
* @summary Partial update of Provisioning Policy
|
|
26959
28310
|
* @param {string} sourceId The Source id.
|
|
26960
|
-
* @param {UsageType} usageType The type of
|
|
28311
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
26961
28312
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation The JSONPatch payload used to update the schema.
|
|
26962
28313
|
* @param {*} [axiosOptions] Override http request option.
|
|
26963
28314
|
* @throws {RequiredError}
|
|
@@ -27019,7 +28370,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
27019
28370
|
* Deletes the provisioning policy with the specified usage on an application. A token with API, or ORG_ADMIN authority is required to call this API.
|
|
27020
28371
|
* @summary Delete Provisioning Policy by UsageType
|
|
27021
28372
|
* @param {string} sourceId The Source ID.
|
|
27022
|
-
* @param {UsageType} usageType The type of
|
|
28373
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27023
28374
|
* @param {*} [axiosOptions] Override http request option.
|
|
27024
28375
|
* @throws {RequiredError}
|
|
27025
28376
|
*/
|
|
@@ -27062,7 +28413,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
27062
28413
|
* This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27063
28414
|
* @summary Get Provisioning Policy by UsageType
|
|
27064
28415
|
* @param {string} sourceId The Source ID.
|
|
27065
|
-
* @param {UsageType} usageType The type of
|
|
28416
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27066
28417
|
* @param {*} [axiosOptions] Override http request option.
|
|
27067
28418
|
* @throws {RequiredError}
|
|
27068
28419
|
*/
|
|
@@ -27154,7 +28505,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
27154
28505
|
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27155
28506
|
* @summary Update Provisioning Policy by UsageType
|
|
27156
28507
|
* @param {string} sourceId The Source ID.
|
|
27157
|
-
* @param {UsageType} usageType The type of
|
|
28508
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27158
28509
|
* @param {ProvisioningPolicyDto} provisioningPolicyDto
|
|
27159
28510
|
* @param {*} [axiosOptions] Override http request option.
|
|
27160
28511
|
* @throws {RequiredError}
|
|
@@ -27192,7 +28543,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
27192
28543
|
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27193
28544
|
* @summary Partial update of Provisioning Policy
|
|
27194
28545
|
* @param {string} sourceId The Source id.
|
|
27195
|
-
* @param {UsageType} usageType The type of
|
|
28546
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27196
28547
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation The JSONPatch payload used to update the schema.
|
|
27197
28548
|
* @param {*} [axiosOptions] Override http request option.
|
|
27198
28549
|
* @throws {RequiredError}
|
|
@@ -27254,7 +28605,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
27254
28605
|
* Deletes the provisioning policy with the specified usage on an application. A token with API, or ORG_ADMIN authority is required to call this API.
|
|
27255
28606
|
* @summary Delete Provisioning Policy by UsageType
|
|
27256
28607
|
* @param {string} sourceId The Source ID.
|
|
27257
|
-
* @param {UsageType} usageType The type of
|
|
28608
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27258
28609
|
* @param {*} [axiosOptions] Override http request option.
|
|
27259
28610
|
* @throws {RequiredError}
|
|
27260
28611
|
*/
|
|
@@ -27297,7 +28648,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
27297
28648
|
* This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27298
28649
|
* @summary Get Provisioning Policy by UsageType
|
|
27299
28650
|
* @param {string} sourceId The Source ID.
|
|
27300
|
-
* @param {UsageType} usageType The type of
|
|
28651
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27301
28652
|
* @param {*} [axiosOptions] Override http request option.
|
|
27302
28653
|
* @throws {RequiredError}
|
|
27303
28654
|
*/
|
|
@@ -27389,7 +28740,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
27389
28740
|
* This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27390
28741
|
* @summary Update Provisioning Policy by UsageType
|
|
27391
28742
|
* @param {string} sourceId The Source ID.
|
|
27392
|
-
* @param {UsageType} usageType The type of
|
|
28743
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27393
28744
|
* @param {ProvisioningPolicyDto} provisioningPolicyDto
|
|
27394
28745
|
* @param {*} [axiosOptions] Override http request option.
|
|
27395
28746
|
* @throws {RequiredError}
|
|
@@ -27427,7 +28778,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
27427
28778
|
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
27428
28779
|
* @summary Partial update of Provisioning Policy
|
|
27429
28780
|
* @param {string} sourceId The Source id.
|
|
27430
|
-
* @param {UsageType} usageType The type of
|
|
28781
|
+
* @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27431
28782
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation The JSONPatch payload used to update the schema.
|
|
27432
28783
|
* @param {*} [axiosOptions] Override http request option.
|
|
27433
28784
|
* @throws {RequiredError}
|
|
@@ -27523,7 +28874,7 @@ export interface SourcesApiDeleteProvisioningPolicyRequest {
|
|
|
27523
28874
|
*/
|
|
27524
28875
|
readonly sourceId: string;
|
|
27525
28876
|
/**
|
|
27526
|
-
* The type of
|
|
28877
|
+
* The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27527
28878
|
* @type {UsageType}
|
|
27528
28879
|
* @memberof SourcesApiDeleteProvisioningPolicy
|
|
27529
28880
|
*/
|
|
@@ -27606,7 +28957,7 @@ export interface SourcesApiGetProvisioningPolicyRequest {
|
|
|
27606
28957
|
*/
|
|
27607
28958
|
readonly sourceId: string;
|
|
27608
28959
|
/**
|
|
27609
|
-
* The type of
|
|
28960
|
+
* The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27610
28961
|
* @type {UsageType}
|
|
27611
28962
|
* @memberof SourcesApiGetProvisioningPolicy
|
|
27612
28963
|
*/
|
|
@@ -27808,7 +29159,7 @@ export interface SourcesApiPutProvisioningPolicyRequest {
|
|
|
27808
29159
|
*/
|
|
27809
29160
|
readonly sourceId: string;
|
|
27810
29161
|
/**
|
|
27811
|
-
* The type of
|
|
29162
|
+
* The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27812
29163
|
* @type {UsageType}
|
|
27813
29164
|
* @memberof SourcesApiPutProvisioningPolicy
|
|
27814
29165
|
*/
|
|
@@ -27896,7 +29247,7 @@ export interface SourcesApiUpdateProvisioningPolicyRequest {
|
|
|
27896
29247
|
*/
|
|
27897
29248
|
readonly sourceId: string;
|
|
27898
29249
|
/**
|
|
27899
|
-
* The type of
|
|
29250
|
+
* The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
27900
29251
|
* @type {UsageType}
|
|
27901
29252
|
* @memberof SourcesApiUpdateProvisioningPolicy
|
|
27902
29253
|
*/
|
|
@@ -28337,7 +29688,7 @@ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => {
|
|
|
28337
29688
|
* @param {*} [axiosOptions] Override http request option.
|
|
28338
29689
|
* @throws {RequiredError}
|
|
28339
29690
|
*/
|
|
28340
|
-
setTagToObject(taggedObject: TaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
29691
|
+
setTagToObject(taggedObject: TaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
28341
29692
|
/**
|
|
28342
29693
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
28343
29694
|
* @summary Tag Multiple Objects
|
|
@@ -28418,7 +29769,7 @@ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, ba
|
|
|
28418
29769
|
* @param {*} [axiosOptions] Override http request option.
|
|
28419
29770
|
* @throws {RequiredError}
|
|
28420
29771
|
*/
|
|
28421
|
-
setTagToObject(taggedObject: TaggedObject, axiosOptions?: any): AxiosPromise<
|
|
29772
|
+
setTagToObject(taggedObject: TaggedObject, axiosOptions?: any): AxiosPromise<void>;
|
|
28422
29773
|
/**
|
|
28423
29774
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
28424
29775
|
* @summary Tag Multiple Objects
|
|
@@ -28667,7 +30018,7 @@ export declare class TaggedObjectsApi extends BaseAPI {
|
|
|
28667
30018
|
* @throws {RequiredError}
|
|
28668
30019
|
* @memberof TaggedObjectsApi
|
|
28669
30020
|
*/
|
|
28670
|
-
setTagToObject(requestParameters: TaggedObjectsApiSetTagToObjectRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
30021
|
+
setTagToObject(requestParameters: TaggedObjectsApiSetTagToObjectRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
28671
30022
|
/**
|
|
28672
30023
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
28673
30024
|
* @summary Tag Multiple Objects
|