@pulumi/okta 5.3.0-alpha.1759905974 → 6.0.0-alpha.1759992240
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/campaign.d.ts +179 -0
- package/campaign.js +87 -0
- package/campaign.js.map +1 -0
- package/endUserMyRequests.d.ts +77 -0
- package/endUserMyRequests.js +63 -0
- package/endUserMyRequests.js.map +1 -0
- package/entitlement.d.ts +155 -0
- package/entitlement.js +92 -0
- package/entitlement.js.map +1 -0
- package/entitlementBundle.d.ts +128 -0
- package/entitlementBundle.js +77 -0
- package/entitlementBundle.js.map +1 -0
- package/getCampaign.d.ts +91 -0
- package/getCampaign.js +68 -0
- package/getCampaign.js.map +1 -0
- package/getCatalogEntryDefault.d.ts +86 -0
- package/getCatalogEntryDefault.js +50 -0
- package/getCatalogEntryDefault.js.map +1 -0
- package/getCatalogEntryUserAccessRequestFields.d.ts +30 -0
- package/getCatalogEntryUserAccessRequestFields.js +26 -0
- package/getCatalogEntryUserAccessRequestFields.js.map +1 -0
- package/getEndUserMyRequests.d.ts +183 -0
- package/getEndUserMyRequests.js +134 -0
- package/getEndUserMyRequests.js.map +1 -0
- package/getEntitlement.d.ts +71 -0
- package/getEntitlement.js +54 -0
- package/getEntitlement.js.map +1 -0
- package/getEntitlementBundle.d.ts +116 -0
- package/getEntitlementBundle.js +54 -0
- package/getEntitlementBundle.js.map +1 -0
- package/getPrincipalEntitlements.d.ts +63 -0
- package/getPrincipalEntitlements.js +34 -0
- package/getPrincipalEntitlements.js.map +1 -0
- package/getPrincipalRateLimits.d.ts +91 -0
- package/getPrincipalRateLimits.js +50 -0
- package/getPrincipalRateLimits.js.map +1 -0
- package/getRateLimitAdminNotificationSettings.d.ts +40 -0
- package/getRateLimitAdminNotificationSettings.js +42 -0
- package/getRateLimitAdminNotificationSettings.js.map +1 -0
- package/getRateLimitWarningThresholdPercentage.d.ts +40 -0
- package/getRateLimitWarningThresholdPercentage.js +42 -0
- package/getRateLimitWarningThresholdPercentage.js.map +1 -0
- package/getRequestCondition.d.ts +108 -0
- package/getRequestCondition.js +58 -0
- package/getRequestCondition.js.map +1 -0
- package/getRequestSequence.d.ts +88 -0
- package/getRequestSequence.js +54 -0
- package/getRequestSequence.js.map +1 -0
- package/getRequestSettingOrganization.d.ts +51 -0
- package/getRequestSettingOrganization.js +48 -0
- package/getRequestSettingOrganization.js.map +1 -0
- package/getRequestSettingResource.d.ts +98 -0
- package/getRequestSettingResource.js +38 -0
- package/getRequestSettingResource.js.map +1 -0
- package/getRequestV2.d.ts +37 -0
- package/getRequestV2.js +28 -0
- package/getRequestV2.js.map +1 -0
- package/getReview.d.ts +154 -0
- package/getReview.js +84 -0
- package/getReview.js.map +1 -0
- package/index.d.ts +87 -0
- package/index.js +117 -3
- package/index.js.map +1 -1
- package/package.json +3 -3
- package/principalRateLimits.d.ts +124 -0
- package/principalRateLimits.js +71 -0
- package/principalRateLimits.js.map +1 -0
- package/rateLimitAdminNotificationSettings.d.ts +66 -0
- package/rateLimitAdminNotificationSettings.js +70 -0
- package/rateLimitAdminNotificationSettings.js.map +1 -0
- package/rateLimitWarningThresholdPercentage.d.ts +65 -0
- package/rateLimitWarningThresholdPercentage.js +69 -0
- package/rateLimitWarningThresholdPercentage.js.map +1 -0
- package/rateLimiting.d.ts +11 -43
- package/rateLimiting.js +6 -24
- package/rateLimiting.js.map +1 -1
- package/realm.d.ts +3 -3
- package/realm.js +0 -3
- package/realm.js.map +1 -1
- package/requestCondition.d.ts +165 -0
- package/requestCondition.js +88 -0
- package/requestCondition.js.map +1 -0
- package/requestSequence.d.ts +113 -0
- package/requestSequence.js +86 -0
- package/requestSequence.js.map +1 -0
- package/requestSettingOrganization.d.ts +69 -0
- package/requestSettingOrganization.js +63 -0
- package/requestSettingOrganization.js.map +1 -0
- package/requestSettingResource.d.ts +83 -0
- package/requestSettingResource.js +65 -0
- package/requestSettingResource.js.map +1 -0
- package/requestV2.d.ts +170 -0
- package/requestV2.js +77 -0
- package/requestV2.js.map +1 -0
- package/review.d.ts +172 -0
- package/review.js +109 -0
- package/review.js.map +1 -0
- package/types/input.d.ts +2156 -147
- package/types/output.d.ts +1263 -2
package/types/output.d.ts
CHANGED
|
@@ -41,6 +41,303 @@ export interface AppUserSchemaPropertyOneOf {
|
|
|
41
41
|
*/
|
|
42
42
|
title: string;
|
|
43
43
|
}
|
|
44
|
+
export interface CampaignNotificationSettings {
|
|
45
|
+
/**
|
|
46
|
+
* To indicate whether a notification should be sent to the reviewer when a given reviewer level period is about to end.
|
|
47
|
+
*/
|
|
48
|
+
notifyReviewPeriodEnd: boolean;
|
|
49
|
+
/**
|
|
50
|
+
* To indicate whether a notification should be sent to the reviewers when campaign has come to an end.
|
|
51
|
+
*/
|
|
52
|
+
notifyReviewerAtCampaignEnd: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* To indicate whether a notification should be sent to the reviewer during the midpoint of the review process.
|
|
55
|
+
*/
|
|
56
|
+
notifyReviewerDuringMidpointOfReview: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* To indicate whether a notification should be sent to the reviewer when the review is overdue.
|
|
59
|
+
*/
|
|
60
|
+
notifyReviewerWhenOverdue: boolean;
|
|
61
|
+
/**
|
|
62
|
+
* To indicate whether a notification should be sent to the reviewer when actionable reviews are assigned.
|
|
63
|
+
*/
|
|
64
|
+
notifyReviewerWhenReviewAssigned: boolean;
|
|
65
|
+
/**
|
|
66
|
+
* Specifies times (in seconds) to send reminders to reviewers before the campaign closes. Max 3 values. Example: [86400, 172800, 604800]
|
|
67
|
+
*/
|
|
68
|
+
remindersReviewerBeforeCampaignCloseInSecs: number[];
|
|
69
|
+
}
|
|
70
|
+
export interface CampaignPrincipalScopeSettings {
|
|
71
|
+
/**
|
|
72
|
+
* An array of Okta user IDs excluded from access certification or the campaign. This field is optional. A maximum of 50 users can be specified in the array.
|
|
73
|
+
*/
|
|
74
|
+
excludedUserIds?: string[];
|
|
75
|
+
/**
|
|
76
|
+
* An array of Okta group IDs included from access certification or the campaign. userIds, groupIds or userScopeExpression is required if campaign type is USER. A maximum of 5 groups can be specified in the array.
|
|
77
|
+
*/
|
|
78
|
+
groupIds?: string[];
|
|
79
|
+
/**
|
|
80
|
+
* If set to true, only active Okta users are included in the campaign.
|
|
81
|
+
*/
|
|
82
|
+
includeOnlyActiveUsers: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* If set to true, only includes users that have at least one SOD conflict that was caused due to entitlement(s) within Campaign scope.
|
|
85
|
+
*/
|
|
86
|
+
onlyIncludeUsersWithSodConflicts: boolean;
|
|
87
|
+
predefinedInactiveUsersScopes?: outputs.CampaignPrincipalScopeSettingsPredefinedInactiveUsersScope[];
|
|
88
|
+
/**
|
|
89
|
+
* Specifies the type for principal_scope_settings.
|
|
90
|
+
*/
|
|
91
|
+
type: string;
|
|
92
|
+
/**
|
|
93
|
+
* An array of Okta user IDs included from access certification or the campaign. userIds, groupIds or userScopeExpression is required if campaign type is USER. A maximum of 100 users can be specified in the array.
|
|
94
|
+
*/
|
|
95
|
+
userIds?: string[];
|
|
96
|
+
/**
|
|
97
|
+
* The Okta expression language user expression on the resourceSettings to include users in the campaign.
|
|
98
|
+
*/
|
|
99
|
+
userScopeExpression?: string;
|
|
100
|
+
}
|
|
101
|
+
export interface CampaignPrincipalScopeSettingsPredefinedInactiveUsersScope {
|
|
102
|
+
/**
|
|
103
|
+
* The duration the users have not used single sign on (SSO) to access their account within the specific time frame. Minimum 30 days and maximum 365 days are supported.
|
|
104
|
+
*/
|
|
105
|
+
inactiveDays?: number;
|
|
106
|
+
}
|
|
107
|
+
export interface CampaignRemediationSettings {
|
|
108
|
+
/**
|
|
109
|
+
* Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
|
|
110
|
+
*/
|
|
111
|
+
accessApproved: string;
|
|
112
|
+
/**
|
|
113
|
+
* Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
|
|
114
|
+
*/
|
|
115
|
+
accessRevoked: string;
|
|
116
|
+
autoRemediationSettings?: outputs.CampaignRemediationSettingsAutoRemediationSettings;
|
|
117
|
+
/**
|
|
118
|
+
* Specifies the action if the reviewer doesn't respond to the request or if the campaign is closed before an action is taken.
|
|
119
|
+
*/
|
|
120
|
+
noResponse: string;
|
|
121
|
+
}
|
|
122
|
+
export interface CampaignRemediationSettingsAutoRemediationSettings {
|
|
123
|
+
/**
|
|
124
|
+
* If true, all indirect assignments will be included in the campaign. If false, only direct assignments will be included.
|
|
125
|
+
*/
|
|
126
|
+
includeAllIndirectAssignments?: boolean;
|
|
127
|
+
includeOnlies?: outputs.CampaignRemediationSettingsAutoRemediationSettingsIncludeOnly[];
|
|
128
|
+
}
|
|
129
|
+
export interface CampaignRemediationSettingsAutoRemediationSettingsIncludeOnly {
|
|
130
|
+
/**
|
|
131
|
+
* The ID of the resource to include in the campaign.
|
|
132
|
+
*/
|
|
133
|
+
resourceId?: string;
|
|
134
|
+
/**
|
|
135
|
+
* The type of the resource to include in the campaign. Valid values are 'APPLICATION', 'GROUP', 'ENTITLEMENT', 'ENTITLEMENT_BUNDLE'.
|
|
136
|
+
*/
|
|
137
|
+
resourceType?: string;
|
|
138
|
+
}
|
|
139
|
+
export interface CampaignResourceSettings {
|
|
140
|
+
/**
|
|
141
|
+
* An array of resources that are excluded from the review.
|
|
142
|
+
*/
|
|
143
|
+
excludedResources?: outputs.CampaignResourceSettingsExcludedResource[];
|
|
144
|
+
/**
|
|
145
|
+
* Include admin roles.
|
|
146
|
+
*/
|
|
147
|
+
includeAdminRoles: boolean;
|
|
148
|
+
/**
|
|
149
|
+
* Include entitlements for this application. This property is only applicable if resourceType = APPLICATION and Entitlement Management is enabled.
|
|
150
|
+
*/
|
|
151
|
+
includeEntitlements: boolean;
|
|
152
|
+
/**
|
|
153
|
+
* Only include individually assigned apps. This is only applicable if campaign type is USER.
|
|
154
|
+
*/
|
|
155
|
+
individuallyAssignedAppsOnly: boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Only include individually assigned groups. This is only applicable if campaign type is USER.
|
|
158
|
+
*/
|
|
159
|
+
individuallyAssignedGroupsOnly: boolean;
|
|
160
|
+
/**
|
|
161
|
+
* Only include out-of-policy entitlements. Only applicable if resourceType = APPLICATION and Entitlement Management is enabled.
|
|
162
|
+
*/
|
|
163
|
+
onlyIncludeOutOfPolicyEntitlements: boolean;
|
|
164
|
+
/**
|
|
165
|
+
* Represents a resource that will be part of Access certifications. If the app is enabled for Access Certifications, it's possible to review entitlements and entitlement bundles.
|
|
166
|
+
*/
|
|
167
|
+
targetResources?: outputs.CampaignResourceSettingsTargetResource[];
|
|
168
|
+
/**
|
|
169
|
+
* The type of Okta resource.
|
|
170
|
+
*/
|
|
171
|
+
type: string;
|
|
172
|
+
}
|
|
173
|
+
export interface CampaignResourceSettingsExcludedResource {
|
|
174
|
+
/**
|
|
175
|
+
* The ID of the resource to exclude in the campaign.
|
|
176
|
+
*/
|
|
177
|
+
resourceId?: string;
|
|
178
|
+
/**
|
|
179
|
+
* The type of resource to exclude in the campaign.
|
|
180
|
+
*/
|
|
181
|
+
resourceType?: string;
|
|
182
|
+
}
|
|
183
|
+
export interface CampaignResourceSettingsTargetResource {
|
|
184
|
+
/**
|
|
185
|
+
* An array of entitlement bundles for this application.
|
|
186
|
+
*/
|
|
187
|
+
entitlementBundles?: outputs.CampaignResourceSettingsTargetResourceEntitlementBundle[];
|
|
188
|
+
/**
|
|
189
|
+
* An array of entitlements associated with resourceId that should be chosen as target when creating reviews
|
|
190
|
+
*/
|
|
191
|
+
entitlements?: outputs.CampaignResourceSettingsTargetResourceEntitlement[];
|
|
192
|
+
/**
|
|
193
|
+
* Include all entitlements and entitlement bundles for this application. Only applicable if the resourcetype = APPLICATION and Entitlement Management is enabled.
|
|
194
|
+
*/
|
|
195
|
+
includeAllEntitlementsAndBundles: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* The resource ID that is being reviewed.
|
|
198
|
+
*/
|
|
199
|
+
resourceId: string;
|
|
200
|
+
/**
|
|
201
|
+
* The type of Okta resource.
|
|
202
|
+
*/
|
|
203
|
+
resourceType: string;
|
|
204
|
+
}
|
|
205
|
+
export interface CampaignResourceSettingsTargetResourceEntitlement {
|
|
206
|
+
/**
|
|
207
|
+
* Campaign id
|
|
208
|
+
*/
|
|
209
|
+
id: string;
|
|
210
|
+
/**
|
|
211
|
+
* Whether to include all entitlement values. If false we must provide the values property.
|
|
212
|
+
*/
|
|
213
|
+
includeAllValues?: boolean;
|
|
214
|
+
values?: outputs.CampaignResourceSettingsTargetResourceEntitlementValue[];
|
|
215
|
+
}
|
|
216
|
+
export interface CampaignResourceSettingsTargetResourceEntitlementBundle {
|
|
217
|
+
/**
|
|
218
|
+
* Campaign id
|
|
219
|
+
*/
|
|
220
|
+
id: string;
|
|
221
|
+
}
|
|
222
|
+
export interface CampaignResourceSettingsTargetResourceEntitlementValue {
|
|
223
|
+
/**
|
|
224
|
+
* Campaign id
|
|
225
|
+
*/
|
|
226
|
+
id: string;
|
|
227
|
+
}
|
|
228
|
+
export interface CampaignReviewerSettings {
|
|
229
|
+
/**
|
|
230
|
+
* When approving or revoking review items, bulk actions are disabled if true.
|
|
231
|
+
*/
|
|
232
|
+
bulkDecisionDisabled: boolean;
|
|
233
|
+
/**
|
|
234
|
+
* The ID of the fallback reviewer. Required when the type=`REVIEWER_EXPRESSION` or type=`RESOURCE_OWNER`
|
|
235
|
+
*/
|
|
236
|
+
fallbackReviewerId?: string;
|
|
237
|
+
/**
|
|
238
|
+
* When approving or revoking review items, a justification is required if true.
|
|
239
|
+
*/
|
|
240
|
+
justificationRequired: boolean;
|
|
241
|
+
/**
|
|
242
|
+
* Reassignment is disabled for reviewers if true.
|
|
243
|
+
*/
|
|
244
|
+
reassignmentDisabled: boolean;
|
|
245
|
+
/**
|
|
246
|
+
* The ID of the reviewer group to which the reviewer is assigned.
|
|
247
|
+
*/
|
|
248
|
+
reviewerGroupId?: string;
|
|
249
|
+
reviewerId?: string;
|
|
250
|
+
/**
|
|
251
|
+
* Definition of reviewer level for a given campaign. Each reviewer level defines the kind of reviewer who is going to review.
|
|
252
|
+
*/
|
|
253
|
+
reviewerLevels?: outputs.CampaignReviewerSettingsReviewerLevel[];
|
|
254
|
+
/**
|
|
255
|
+
* This property is required when type=`USER`
|
|
256
|
+
*/
|
|
257
|
+
reviewerScopeExpression?: string;
|
|
258
|
+
/**
|
|
259
|
+
* This property is required to be true for resource-centric campaigns when the Okta Admin Console is one of the resources.
|
|
260
|
+
*/
|
|
261
|
+
selfReviewDisabled: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* Identifies the kind of reviewer for Access Certification.
|
|
264
|
+
*/
|
|
265
|
+
type: string;
|
|
266
|
+
}
|
|
267
|
+
export interface CampaignReviewerSettingsReviewerLevel {
|
|
268
|
+
/**
|
|
269
|
+
* Required when the type=`REVIEWER_EXPRESSION` or type=`RESOURCE_OWNER`
|
|
270
|
+
*/
|
|
271
|
+
fallbackReviewerId: string;
|
|
272
|
+
/**
|
|
273
|
+
* The ID of the reviewer group to which the reviewer is assigned.This property is required when type=`GROUP`
|
|
274
|
+
*/
|
|
275
|
+
reviewerGroupId: string;
|
|
276
|
+
/**
|
|
277
|
+
* The ID of the reviewer to which the reviewer is assigned.This property is required when type=`USER`.
|
|
278
|
+
*/
|
|
279
|
+
reviewerId?: string;
|
|
280
|
+
/**
|
|
281
|
+
* This property is required when type=`REVIEWER_EXPRESSION`
|
|
282
|
+
*/
|
|
283
|
+
reviewerScopeExpression: string;
|
|
284
|
+
/**
|
|
285
|
+
* This property is used to prevent self review.
|
|
286
|
+
*/
|
|
287
|
+
selfReviewDisabled: boolean;
|
|
288
|
+
/**
|
|
289
|
+
* The rules for which the reviews can move to that level.
|
|
290
|
+
*/
|
|
291
|
+
startReviews?: outputs.CampaignReviewerSettingsReviewerLevelStartReview[];
|
|
292
|
+
/**
|
|
293
|
+
* Identifies the kind of reviewer.
|
|
294
|
+
*/
|
|
295
|
+
type: string;
|
|
296
|
+
}
|
|
297
|
+
export interface CampaignReviewerSettingsReviewerLevelStartReview {
|
|
298
|
+
/**
|
|
299
|
+
* The day of the campaign when the review starts. 0 means the first day of the campaign.
|
|
300
|
+
*/
|
|
301
|
+
onDay: number;
|
|
302
|
+
/**
|
|
303
|
+
* The condition for which, the lower level reviews will move to that level for further review.
|
|
304
|
+
*/
|
|
305
|
+
when: string;
|
|
306
|
+
}
|
|
307
|
+
export interface CampaignScheduleSettings {
|
|
308
|
+
/**
|
|
309
|
+
* The duration (in days) that the campaign is active.
|
|
310
|
+
*/
|
|
311
|
+
durationInDays: number;
|
|
312
|
+
endDate?: string;
|
|
313
|
+
recurrences?: outputs.CampaignScheduleSettingsRecurrence[];
|
|
314
|
+
/**
|
|
315
|
+
* The date on which the campaign is supposed to start. Accepts date in ISO 8601 format.
|
|
316
|
+
*/
|
|
317
|
+
startDate: string;
|
|
318
|
+
/**
|
|
319
|
+
* The time zone in which the campaign is active.
|
|
320
|
+
*/
|
|
321
|
+
timeZone: string;
|
|
322
|
+
/**
|
|
323
|
+
* The type of campaign being scheduled.
|
|
324
|
+
*/
|
|
325
|
+
type: string;
|
|
326
|
+
}
|
|
327
|
+
export interface CampaignScheduleSettingsRecurrence {
|
|
328
|
+
/**
|
|
329
|
+
* Specifies when the recurring schedule can have an end.
|
|
330
|
+
*/
|
|
331
|
+
ends?: string;
|
|
332
|
+
/**
|
|
333
|
+
* Recurrence interval specified according to ISO8061 notation for durations.
|
|
334
|
+
*/
|
|
335
|
+
interval: string;
|
|
336
|
+
/**
|
|
337
|
+
* Specifies when the recurring schedule can have an end.
|
|
338
|
+
*/
|
|
339
|
+
repeatOnType?: string;
|
|
340
|
+
}
|
|
44
341
|
export interface CustomizedSigninPageContentSecurityPolicySetting {
|
|
45
342
|
/**
|
|
46
343
|
* enforced or report_only
|
|
@@ -124,6 +421,79 @@ export interface EmailSenderDnsRecord {
|
|
|
124
421
|
*/
|
|
125
422
|
value: string;
|
|
126
423
|
}
|
|
424
|
+
export interface EndUserMyRequestsRequesterFieldValue {
|
|
425
|
+
/**
|
|
426
|
+
* The ID of a requesterField. This identifies the specific field in the approval system.
|
|
427
|
+
*/
|
|
428
|
+
id: string;
|
|
429
|
+
/**
|
|
430
|
+
* A human-readable description of requesterField. It's used for display purposes and is optional.
|
|
431
|
+
*/
|
|
432
|
+
label?: string;
|
|
433
|
+
/**
|
|
434
|
+
* Type of value for the requester field. Valid values: `DURATION`, `ISO_DATE`, `MULTISELECT`, `OKTA_USER_ID`, `SELECT`, `TEXT`.
|
|
435
|
+
*/
|
|
436
|
+
type?: string;
|
|
437
|
+
/**
|
|
438
|
+
* The value of requesterField, which depends on the type of the field. Used for single-value fields.
|
|
439
|
+
*/
|
|
440
|
+
value?: string;
|
|
441
|
+
/**
|
|
442
|
+
* The values of requesterField with the type MULTISELECT. If the field type is MULTISELECT, this property is required instead of `value`.
|
|
443
|
+
*/
|
|
444
|
+
values?: string[];
|
|
445
|
+
}
|
|
446
|
+
export interface EntitlementBundleEntitlement {
|
|
447
|
+
/**
|
|
448
|
+
* The ID of the entitlement.
|
|
449
|
+
*/
|
|
450
|
+
id: string;
|
|
451
|
+
values?: outputs.EntitlementBundleEntitlementValue[];
|
|
452
|
+
}
|
|
453
|
+
export interface EntitlementBundleEntitlementValue {
|
|
454
|
+
/**
|
|
455
|
+
* The ID of the entitlement value.
|
|
456
|
+
*/
|
|
457
|
+
id: string;
|
|
458
|
+
}
|
|
459
|
+
export interface EntitlementBundleTarget {
|
|
460
|
+
/**
|
|
461
|
+
* The Okta app ID of the resource.
|
|
462
|
+
*/
|
|
463
|
+
externalId: string;
|
|
464
|
+
/**
|
|
465
|
+
* The type of resource.
|
|
466
|
+
*/
|
|
467
|
+
type: string;
|
|
468
|
+
}
|
|
469
|
+
export interface EntitlementParent {
|
|
470
|
+
/**
|
|
471
|
+
* The Okta app ID of the resource.
|
|
472
|
+
*/
|
|
473
|
+
externalId: string;
|
|
474
|
+
/**
|
|
475
|
+
* The type of resource.
|
|
476
|
+
*/
|
|
477
|
+
type: string;
|
|
478
|
+
}
|
|
479
|
+
export interface EntitlementValue {
|
|
480
|
+
/**
|
|
481
|
+
* The description of an entitlement value.
|
|
482
|
+
*/
|
|
483
|
+
description?: string;
|
|
484
|
+
/**
|
|
485
|
+
* The value of an entitlement property value.
|
|
486
|
+
*/
|
|
487
|
+
externalValue?: string;
|
|
488
|
+
/**
|
|
489
|
+
* Collection of entitlement values.
|
|
490
|
+
*/
|
|
491
|
+
id: string;
|
|
492
|
+
/**
|
|
493
|
+
* The display name for an entitlement value.
|
|
494
|
+
*/
|
|
495
|
+
name?: string;
|
|
496
|
+
}
|
|
127
497
|
export interface EventHookHeader {
|
|
128
498
|
key?: string;
|
|
129
499
|
value?: string;
|
|
@@ -234,6 +604,250 @@ export interface GetBrandsBrand {
|
|
|
234
604
|
*/
|
|
235
605
|
removePoweredByOkta: boolean;
|
|
236
606
|
}
|
|
607
|
+
export interface GetCampaignNotificationSettings {
|
|
608
|
+
notifyReviewPeriodEnd: boolean;
|
|
609
|
+
notifyReviewerAtCampaignEnd: boolean;
|
|
610
|
+
notifyReviewerDuringMidpointOfReview: boolean;
|
|
611
|
+
notifyReviewerWhenOverdue: boolean;
|
|
612
|
+
notifyReviewerWhenReviewAssigned: boolean;
|
|
613
|
+
remindersReviewerBeforeCampaignCloseInSecs: number[];
|
|
614
|
+
}
|
|
615
|
+
export interface GetCampaignPrincipalScopeSettings {
|
|
616
|
+
excludedUserIds: string[];
|
|
617
|
+
groupIds: string[];
|
|
618
|
+
includeOnlyActiveUsers: boolean;
|
|
619
|
+
onlyIncludeUsersWithSodConflicts: boolean;
|
|
620
|
+
predefinedInactiveUsersScopes?: outputs.GetCampaignPrincipalScopeSettingsPredefinedInactiveUsersScope[];
|
|
621
|
+
type: string;
|
|
622
|
+
userIds: string[];
|
|
623
|
+
userScopeExpression: string;
|
|
624
|
+
}
|
|
625
|
+
export interface GetCampaignPrincipalScopeSettingsPredefinedInactiveUsersScope {
|
|
626
|
+
inactiveDays: number;
|
|
627
|
+
}
|
|
628
|
+
export interface GetCampaignRemediationSettings {
|
|
629
|
+
/**
|
|
630
|
+
* Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
|
|
631
|
+
*/
|
|
632
|
+
accessApproved: string;
|
|
633
|
+
/**
|
|
634
|
+
* Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
|
|
635
|
+
*/
|
|
636
|
+
accessRevoked: string;
|
|
637
|
+
autoRemediationSettings?: outputs.GetCampaignRemediationSettingsAutoRemediationSettings;
|
|
638
|
+
/**
|
|
639
|
+
* Specifies the action if the reviewer doesn't respond to the request.
|
|
640
|
+
*/
|
|
641
|
+
noResponse: string;
|
|
642
|
+
}
|
|
643
|
+
export interface GetCampaignRemediationSettingsAutoRemediationSettings {
|
|
644
|
+
/**
|
|
645
|
+
* When a group is selected to be automatically remediated.
|
|
646
|
+
*/
|
|
647
|
+
includeAllIndirectAssignments: boolean;
|
|
648
|
+
/**
|
|
649
|
+
* An array of resources to be automatically remediated.
|
|
650
|
+
*/
|
|
651
|
+
includeOnlies?: outputs.GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly[];
|
|
652
|
+
}
|
|
653
|
+
export interface GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly {
|
|
654
|
+
/**
|
|
655
|
+
* The resource ID of the target resource When type = GROUP, it will point to the group ID.
|
|
656
|
+
*/
|
|
657
|
+
resourceId: string;
|
|
658
|
+
/**
|
|
659
|
+
* The type of the resource to be automatically remediated. Only GROUP is supported.
|
|
660
|
+
*/
|
|
661
|
+
resourceType: string;
|
|
662
|
+
}
|
|
663
|
+
export interface GetCampaignResourceSettings {
|
|
664
|
+
/**
|
|
665
|
+
* An array of resources that are excluded from the review.
|
|
666
|
+
*/
|
|
667
|
+
excludedResources?: outputs.GetCampaignResourceSettingsExcludedResource[];
|
|
668
|
+
/**
|
|
669
|
+
* Include admin roles.
|
|
670
|
+
*/
|
|
671
|
+
includeAdminRoles: boolean;
|
|
672
|
+
/**
|
|
673
|
+
* Include entitlements for this application.
|
|
674
|
+
*/
|
|
675
|
+
includeEntitlements: boolean;
|
|
676
|
+
/**
|
|
677
|
+
* Only include individually assigned groups.
|
|
678
|
+
*/
|
|
679
|
+
individuallyAssignedAppsOnly: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* Only include individually assigned groups.
|
|
682
|
+
*/
|
|
683
|
+
individuallyAssignedGroupsOnly: boolean;
|
|
684
|
+
/**
|
|
685
|
+
* Only include out-of-policy entitlements.
|
|
686
|
+
*/
|
|
687
|
+
onlyIncludeOutOfPolicyEntitlements: boolean;
|
|
688
|
+
/**
|
|
689
|
+
* Represents a resource that will be part of Access certifications.
|
|
690
|
+
*/
|
|
691
|
+
targetResources?: outputs.GetCampaignResourceSettingsTargetResource[];
|
|
692
|
+
/**
|
|
693
|
+
* The type of Okta resource.
|
|
694
|
+
*/
|
|
695
|
+
type: string;
|
|
696
|
+
}
|
|
697
|
+
export interface GetCampaignResourceSettingsExcludedResource {
|
|
698
|
+
/**
|
|
699
|
+
* Okta specific resource ID.
|
|
700
|
+
*/
|
|
701
|
+
resourceId: string;
|
|
702
|
+
/**
|
|
703
|
+
* The type of Okta resource.
|
|
704
|
+
*/
|
|
705
|
+
resourceType: string;
|
|
706
|
+
}
|
|
707
|
+
export interface GetCampaignResourceSettingsTargetResource {
|
|
708
|
+
/**
|
|
709
|
+
* An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
|
|
710
|
+
*/
|
|
711
|
+
entitlementBundles?: outputs.GetCampaignResourceSettingsTargetResourceEntitlementBundle[];
|
|
712
|
+
entitlements?: outputs.GetCampaignResourceSettingsTargetResourceEntitlement[];
|
|
713
|
+
/**
|
|
714
|
+
* Include all entitlements and entitlement bundles for this application.
|
|
715
|
+
*/
|
|
716
|
+
includeAllEntitlementsAndBundles: boolean;
|
|
717
|
+
/**
|
|
718
|
+
* The resource ID that is being reviewed.
|
|
719
|
+
*/
|
|
720
|
+
resourceId: string;
|
|
721
|
+
/**
|
|
722
|
+
* The type of Okta resource.
|
|
723
|
+
*/
|
|
724
|
+
resourceType: string;
|
|
725
|
+
}
|
|
726
|
+
export interface GetCampaignResourceSettingsTargetResourceEntitlement {
|
|
727
|
+
/**
|
|
728
|
+
* The ID of this resource.
|
|
729
|
+
*/
|
|
730
|
+
id: string;
|
|
731
|
+
/**
|
|
732
|
+
* Whether to include all values for this entitlement.
|
|
733
|
+
*/
|
|
734
|
+
includeAllValues: boolean;
|
|
735
|
+
/**
|
|
736
|
+
* Entitlement value ids
|
|
737
|
+
*/
|
|
738
|
+
values?: outputs.GetCampaignResourceSettingsTargetResourceEntitlementValue[];
|
|
739
|
+
}
|
|
740
|
+
export interface GetCampaignResourceSettingsTargetResourceEntitlementBundle {
|
|
741
|
+
/**
|
|
742
|
+
* The ID of this resource.
|
|
743
|
+
*/
|
|
744
|
+
id: string;
|
|
745
|
+
}
|
|
746
|
+
export interface GetCampaignResourceSettingsTargetResourceEntitlementValue {
|
|
747
|
+
/**
|
|
748
|
+
* The ID of this resource.
|
|
749
|
+
*/
|
|
750
|
+
id: string;
|
|
751
|
+
}
|
|
752
|
+
export interface GetCampaignReviewerSettings {
|
|
753
|
+
bulkDecisionDisabled: boolean;
|
|
754
|
+
fallbackReviewerId: string;
|
|
755
|
+
justificationRequired: boolean;
|
|
756
|
+
reassignmentDisabled: boolean;
|
|
757
|
+
reviewerGroupId: string;
|
|
758
|
+
reviewerId: string;
|
|
759
|
+
reviewerLevels?: outputs.GetCampaignReviewerSettingsReviewerLevel[];
|
|
760
|
+
reviewerScopeExpression: string;
|
|
761
|
+
selfReviewDisabled: boolean;
|
|
762
|
+
type: string;
|
|
763
|
+
}
|
|
764
|
+
export interface GetCampaignReviewerSettingsReviewerLevel {
|
|
765
|
+
fallbackReviewerId: string;
|
|
766
|
+
reviewerGroupId: string;
|
|
767
|
+
reviewerId: string;
|
|
768
|
+
reviewerScopeExpression: string;
|
|
769
|
+
selfReviewDisabled: boolean;
|
|
770
|
+
startReviews?: outputs.GetCampaignReviewerSettingsReviewerLevelStartReview[];
|
|
771
|
+
type: string;
|
|
772
|
+
}
|
|
773
|
+
export interface GetCampaignReviewerSettingsReviewerLevelStartReview {
|
|
774
|
+
onDay: number;
|
|
775
|
+
when: string;
|
|
776
|
+
}
|
|
777
|
+
export interface GetCampaignScheduleSettings {
|
|
778
|
+
durationInDays: number;
|
|
779
|
+
endDate: string;
|
|
780
|
+
recurrences?: outputs.GetCampaignScheduleSettingsRecurrence[];
|
|
781
|
+
startDate: string;
|
|
782
|
+
timeZone: string;
|
|
783
|
+
type: string;
|
|
784
|
+
}
|
|
785
|
+
export interface GetCampaignScheduleSettingsRecurrence {
|
|
786
|
+
ends: string;
|
|
787
|
+
interval: string;
|
|
788
|
+
repeatOnType: string;
|
|
789
|
+
}
|
|
790
|
+
export interface GetCatalogEntryDefaultCounts {
|
|
791
|
+
/**
|
|
792
|
+
* Collection resource counts.
|
|
793
|
+
*/
|
|
794
|
+
resourceCounts?: outputs.GetCatalogEntryDefaultCountsResourceCounts;
|
|
795
|
+
}
|
|
796
|
+
export interface GetCatalogEntryDefaultCountsResourceCounts {
|
|
797
|
+
/**
|
|
798
|
+
* Number of app resources in a collection.
|
|
799
|
+
*/
|
|
800
|
+
applications: number;
|
|
801
|
+
}
|
|
802
|
+
export interface GetCatalogEntryDefaultLinks {
|
|
803
|
+
/**
|
|
804
|
+
* A link to the catalog entry itself.
|
|
805
|
+
*/
|
|
806
|
+
self?: outputs.GetCatalogEntryDefaultLinksSelf;
|
|
807
|
+
}
|
|
808
|
+
export interface GetCatalogEntryDefaultLinksSelf {
|
|
809
|
+
/**
|
|
810
|
+
* Contains the absolute API URL for retrieving this catalog entry resource.
|
|
811
|
+
*/
|
|
812
|
+
href: string;
|
|
813
|
+
}
|
|
814
|
+
export interface GetCatalogEntryUserAccessRequestFieldsData {
|
|
815
|
+
/**
|
|
816
|
+
* Valid choices when type is SELECT or MULTISELECT.
|
|
817
|
+
*/
|
|
818
|
+
choices?: outputs.GetCatalogEntryUserAccessRequestFieldsDataChoice[];
|
|
819
|
+
id: string;
|
|
820
|
+
/**
|
|
821
|
+
* Label of the requester field.
|
|
822
|
+
*/
|
|
823
|
+
label: string;
|
|
824
|
+
/**
|
|
825
|
+
* The maximum value allowed for this field. Only applies to DURATION fields.
|
|
826
|
+
*/
|
|
827
|
+
maximumValue: string;
|
|
828
|
+
/**
|
|
829
|
+
* Indicates this field is immutable.
|
|
830
|
+
*/
|
|
831
|
+
readOnly: boolean;
|
|
832
|
+
/**
|
|
833
|
+
* Indicates whether a value to this field is required to advance the request.
|
|
834
|
+
*/
|
|
835
|
+
required: boolean;
|
|
836
|
+
/**
|
|
837
|
+
* Type of value for the requester field.
|
|
838
|
+
*/
|
|
839
|
+
type: string;
|
|
840
|
+
/**
|
|
841
|
+
* An admin configured value for this field. Only applies to DURATION fields.
|
|
842
|
+
*/
|
|
843
|
+
value: string;
|
|
844
|
+
}
|
|
845
|
+
export interface GetCatalogEntryUserAccessRequestFieldsDataChoice {
|
|
846
|
+
/**
|
|
847
|
+
* Valid choice.
|
|
848
|
+
*/
|
|
849
|
+
choice: string;
|
|
850
|
+
}
|
|
237
851
|
export interface GetDefaultSigninPageContentSecurityPolicySetting {
|
|
238
852
|
/**
|
|
239
853
|
* enforced or report_only
|
|
@@ -360,9 +974,192 @@ export interface GetEmailCustomizationsEmailCustomization {
|
|
|
360
974
|
*/
|
|
361
975
|
links: string;
|
|
362
976
|
/**
|
|
363
|
-
* The subject of the customization
|
|
977
|
+
* The subject of the customization
|
|
978
|
+
*/
|
|
979
|
+
subject: string;
|
|
980
|
+
}
|
|
981
|
+
export interface GetEndUserMyRequestsRequested {
|
|
982
|
+
/**
|
|
983
|
+
* ID of the access scope
|
|
984
|
+
*/
|
|
985
|
+
accessScopeId: string;
|
|
986
|
+
/**
|
|
987
|
+
* The access scope type
|
|
988
|
+
*/
|
|
989
|
+
accessScopeType: string;
|
|
990
|
+
/**
|
|
991
|
+
* The ID of the catalog entry for which the request was made.
|
|
992
|
+
*/
|
|
993
|
+
entryId: string;
|
|
994
|
+
/**
|
|
995
|
+
* The requested resource ID
|
|
996
|
+
*/
|
|
997
|
+
resourceId: string;
|
|
998
|
+
/**
|
|
999
|
+
* The requested resource type.
|
|
1000
|
+
*/
|
|
1001
|
+
resourceType: string;
|
|
1002
|
+
}
|
|
1003
|
+
export interface GetEndUserMyRequestsRequestedBy {
|
|
1004
|
+
/**
|
|
1005
|
+
* The Okta user id
|
|
1006
|
+
*/
|
|
1007
|
+
externalId: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* The type of principal
|
|
1010
|
+
*/
|
|
1011
|
+
type: string;
|
|
1012
|
+
}
|
|
1013
|
+
export interface GetEndUserMyRequestsRequestedFor {
|
|
1014
|
+
/**
|
|
1015
|
+
* The Okta user id
|
|
1016
|
+
*/
|
|
1017
|
+
externalId: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* The type of principal
|
|
1020
|
+
*/
|
|
1021
|
+
type: string;
|
|
1022
|
+
}
|
|
1023
|
+
export interface GetEndUserMyRequestsRequesterFieldValue {
|
|
1024
|
+
/**
|
|
1025
|
+
* The ID of the requester field.
|
|
1026
|
+
*/
|
|
1027
|
+
id: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* A human-readable description of the requester field.
|
|
1030
|
+
*/
|
|
1031
|
+
label?: string;
|
|
1032
|
+
/**
|
|
1033
|
+
* Type of value for the requester field. Valid values: `DURATION`, `ISO_DATE`, `MULTISELECT`, `OKTA_USER_ID`, `SELECT`, `TEXT`.
|
|
1034
|
+
*/
|
|
1035
|
+
type?: string;
|
|
1036
|
+
/**
|
|
1037
|
+
* The value of the requester field (for single-value fields).
|
|
1038
|
+
*/
|
|
1039
|
+
value?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* The values of the requester field (for MULTISELECT type fields).
|
|
1042
|
+
*/
|
|
1043
|
+
values?: string[];
|
|
1044
|
+
}
|
|
1045
|
+
export interface GetEndUserMyRequestsRiskAssessment {
|
|
1046
|
+
/**
|
|
1047
|
+
* Whether request submission is allowed or restricted in the risk settings.
|
|
1048
|
+
*/
|
|
1049
|
+
requestSubmissionType?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* An array of resources that are excluded from the review.
|
|
1052
|
+
*/
|
|
1053
|
+
riskRules?: outputs.GetEndUserMyRequestsRiskAssessmentRiskRule[];
|
|
1054
|
+
}
|
|
1055
|
+
export interface GetEndUserMyRequestsRiskAssessmentRiskRule {
|
|
1056
|
+
/**
|
|
1057
|
+
* The human readable description.
|
|
1058
|
+
*/
|
|
1059
|
+
description?: string;
|
|
1060
|
+
/**
|
|
1061
|
+
* The name of a resource rule causing a conflict.
|
|
1062
|
+
*/
|
|
1063
|
+
name?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* Human readable name of the resource.
|
|
1066
|
+
*/
|
|
1067
|
+
resourceName?: string;
|
|
1068
|
+
}
|
|
1069
|
+
export interface GetEntitlementBundleEntitlement {
|
|
1070
|
+
/**
|
|
1071
|
+
* The data type of the entitlement property.
|
|
1072
|
+
*/
|
|
1073
|
+
dataType: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* The description of an entitlement property.
|
|
1076
|
+
*/
|
|
1077
|
+
description: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* The value of an entitlement property.
|
|
1080
|
+
*/
|
|
1081
|
+
externalValue: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* The ID of this resource.
|
|
1084
|
+
*/
|
|
1085
|
+
id: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* The property that determines if the entitlement property can hold multiple values.
|
|
1088
|
+
*/
|
|
1089
|
+
multiValue: boolean;
|
|
1090
|
+
/**
|
|
1091
|
+
* The display name for an entitlement bundle.
|
|
1092
|
+
*/
|
|
1093
|
+
name: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* The property that determines if the entitlement property is a required attribute.
|
|
1096
|
+
*/
|
|
1097
|
+
required: boolean;
|
|
1098
|
+
values?: outputs.GetEntitlementBundleEntitlementValue[];
|
|
1099
|
+
}
|
|
1100
|
+
export interface GetEntitlementBundleEntitlementValue {
|
|
1101
|
+
/**
|
|
1102
|
+
* The description of an entitlement property.
|
|
1103
|
+
*/
|
|
1104
|
+
description: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* The read-only id of an entitlement property value in the downstream application.
|
|
1107
|
+
*/
|
|
1108
|
+
externalId: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* The value of an entitlement property value.
|
|
1111
|
+
*/
|
|
1112
|
+
externalValue: string;
|
|
1113
|
+
/**
|
|
1114
|
+
* The ID of this resource.
|
|
1115
|
+
*/
|
|
1116
|
+
id: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* The display name for an entitlement bundle.
|
|
1119
|
+
*/
|
|
1120
|
+
name: string;
|
|
1121
|
+
}
|
|
1122
|
+
export interface GetEntitlementBundleTarget {
|
|
1123
|
+
/**
|
|
1124
|
+
* The Okta app.id of the resource.
|
|
1125
|
+
*/
|
|
1126
|
+
externalId: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* The type of the resource.
|
|
1129
|
+
*/
|
|
1130
|
+
type: string;
|
|
1131
|
+
}
|
|
1132
|
+
export interface GetEntitlementParent {
|
|
1133
|
+
/**
|
|
1134
|
+
* The Okta app.id of the resource.
|
|
1135
|
+
*/
|
|
1136
|
+
externalId: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* The type of resource.
|
|
1139
|
+
*/
|
|
1140
|
+
type: string;
|
|
1141
|
+
}
|
|
1142
|
+
export interface GetEntitlementValue {
|
|
1143
|
+
/**
|
|
1144
|
+
* The description of an entitlement value.
|
|
1145
|
+
*/
|
|
1146
|
+
description: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* The id of the entitlement value.
|
|
1149
|
+
*/
|
|
1150
|
+
externalId: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* The value of an entitlement property value.
|
|
1153
|
+
*/
|
|
1154
|
+
externalValue: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* The ID of this resource.
|
|
1157
|
+
*/
|
|
1158
|
+
id: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* The name of the entitlement value.
|
|
364
1161
|
*/
|
|
365
|
-
|
|
1162
|
+
name: string;
|
|
366
1163
|
}
|
|
367
1164
|
export interface GetFeaturesFeature {
|
|
368
1165
|
description: string;
|
|
@@ -446,6 +1243,327 @@ export interface GetOrgMetadataSettings {
|
|
|
446
1243
|
*/
|
|
447
1244
|
omEnabled: boolean;
|
|
448
1245
|
}
|
|
1246
|
+
export interface GetPrincipalEntitlementsData {
|
|
1247
|
+
/**
|
|
1248
|
+
* The data type of the entitlement property.
|
|
1249
|
+
*/
|
|
1250
|
+
dataType: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* The description of an entitlement property.
|
|
1253
|
+
*/
|
|
1254
|
+
description: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* The value of an entitlement property.
|
|
1257
|
+
*/
|
|
1258
|
+
externalValue: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* The id property of an entitlement.
|
|
1261
|
+
*/
|
|
1262
|
+
id: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* The property that determines if the entitlement property can hold multiple values.
|
|
1265
|
+
*/
|
|
1266
|
+
multiValue: boolean;
|
|
1267
|
+
/**
|
|
1268
|
+
* The display name for an entitlement property.
|
|
1269
|
+
*/
|
|
1270
|
+
name: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* Representation of a resource.
|
|
1273
|
+
*/
|
|
1274
|
+
parent?: outputs.GetPrincipalEntitlementsDataParent;
|
|
1275
|
+
/**
|
|
1276
|
+
* The Okta app instance, in ORN format.
|
|
1277
|
+
*/
|
|
1278
|
+
parentResourceOrn: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* The property that determines if the entitlement property is a required attribute
|
|
1281
|
+
*/
|
|
1282
|
+
required: boolean;
|
|
1283
|
+
/**
|
|
1284
|
+
* Representation of a principal.
|
|
1285
|
+
*/
|
|
1286
|
+
targetPrincipal?: outputs.GetPrincipalEntitlementsDataTargetPrincipal;
|
|
1287
|
+
/**
|
|
1288
|
+
* The Okta user id in ORN format.
|
|
1289
|
+
*/
|
|
1290
|
+
targetPrincipalOrn: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* Collection of entitlement values.
|
|
1293
|
+
*/
|
|
1294
|
+
values?: outputs.GetPrincipalEntitlementsDataValue[];
|
|
1295
|
+
}
|
|
1296
|
+
export interface GetPrincipalEntitlementsDataParent {
|
|
1297
|
+
/**
|
|
1298
|
+
* The Okta id of the resource.
|
|
1299
|
+
*/
|
|
1300
|
+
externalId: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* The type of the resource.
|
|
1303
|
+
*/
|
|
1304
|
+
type: string;
|
|
1305
|
+
}
|
|
1306
|
+
export interface GetPrincipalEntitlementsDataTargetPrincipal {
|
|
1307
|
+
/**
|
|
1308
|
+
* The Okta user id.
|
|
1309
|
+
*/
|
|
1310
|
+
externalId: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* The type of principal.
|
|
1313
|
+
*/
|
|
1314
|
+
type: string;
|
|
1315
|
+
}
|
|
1316
|
+
export interface GetPrincipalEntitlementsDataValue {
|
|
1317
|
+
/**
|
|
1318
|
+
* The description of an entitlement property.
|
|
1319
|
+
*/
|
|
1320
|
+
description: string;
|
|
1321
|
+
/**
|
|
1322
|
+
* The value of an entitlement property value.
|
|
1323
|
+
*/
|
|
1324
|
+
externalValue: string;
|
|
1325
|
+
/**
|
|
1326
|
+
* The id of an entitlement value.
|
|
1327
|
+
*/
|
|
1328
|
+
id: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* The name of an entitlement value.
|
|
1331
|
+
*/
|
|
1332
|
+
name: string;
|
|
1333
|
+
}
|
|
1334
|
+
export interface GetPrincipalEntitlementsParent {
|
|
1335
|
+
externalId: string;
|
|
1336
|
+
type: string;
|
|
1337
|
+
}
|
|
1338
|
+
export interface GetPrincipalEntitlementsTargetPrincipal {
|
|
1339
|
+
externalId: string;
|
|
1340
|
+
type: string;
|
|
1341
|
+
}
|
|
1342
|
+
export interface GetRequestConditionAccessScopeSettings {
|
|
1343
|
+
/**
|
|
1344
|
+
* List of groups/entitlement bundles.
|
|
1345
|
+
*/
|
|
1346
|
+
ids?: outputs.GetRequestConditionAccessScopeSettingsId[];
|
|
1347
|
+
type: string;
|
|
1348
|
+
}
|
|
1349
|
+
export interface GetRequestConditionAccessScopeSettingsId {
|
|
1350
|
+
/**
|
|
1351
|
+
* Request condition id.
|
|
1352
|
+
*/
|
|
1353
|
+
id: string;
|
|
1354
|
+
}
|
|
1355
|
+
export interface GetRequestConditionRequesterSettings {
|
|
1356
|
+
/**
|
|
1357
|
+
* List of teams/groups ids.
|
|
1358
|
+
*/
|
|
1359
|
+
ids?: outputs.GetRequestConditionRequesterSettingsId[];
|
|
1360
|
+
type: string;
|
|
1361
|
+
}
|
|
1362
|
+
export interface GetRequestConditionRequesterSettingsId {
|
|
1363
|
+
/**
|
|
1364
|
+
* Request condition id.
|
|
1365
|
+
*/
|
|
1366
|
+
id: string;
|
|
1367
|
+
}
|
|
1368
|
+
export interface GetRequestSettingOrganizationRequestExperience {
|
|
1369
|
+
experienceType: string;
|
|
1370
|
+
}
|
|
1371
|
+
export interface GetRequestSettingResourceRequestOnBehalfOfSettings {
|
|
1372
|
+
allowed: boolean;
|
|
1373
|
+
onlyFors?: outputs.GetRequestSettingResourceRequestOnBehalfOfSettingsOnlyFor[];
|
|
1374
|
+
}
|
|
1375
|
+
export interface GetRequestSettingResourceRequestOnBehalfOfSettingsOnlyFor {
|
|
1376
|
+
type: string;
|
|
1377
|
+
}
|
|
1378
|
+
export interface GetRequestSettingResourceRiskSettings {
|
|
1379
|
+
/**
|
|
1380
|
+
* Default risk settings that are valid for an access request when a risk has been detected for the resource and requesting user.
|
|
1381
|
+
*/
|
|
1382
|
+
defaultSetting?: outputs.GetRequestSettingResourceRiskSettingsDefaultSetting;
|
|
1383
|
+
}
|
|
1384
|
+
export interface GetRequestSettingResourceRiskSettingsDefaultSetting {
|
|
1385
|
+
accessDurationSettings?: outputs.GetRequestSettingResourceRiskSettingsDefaultSettingAccessDurationSettings;
|
|
1386
|
+
approvalSequenceId: string;
|
|
1387
|
+
errors: string[];
|
|
1388
|
+
requestSubmissionType: string;
|
|
1389
|
+
}
|
|
1390
|
+
export interface GetRequestSettingResourceRiskSettingsDefaultSettingAccessDurationSettings {
|
|
1391
|
+
duration: string;
|
|
1392
|
+
type: string;
|
|
1393
|
+
}
|
|
1394
|
+
export interface GetRequestSettingResourceValidAccessDurationSettings {
|
|
1395
|
+
/**
|
|
1396
|
+
* The maximum value allowed for a request condition or risk setting.
|
|
1397
|
+
*/
|
|
1398
|
+
maximumDays: number;
|
|
1399
|
+
/**
|
|
1400
|
+
* The maximum value allowed for a request condition or risk setting.
|
|
1401
|
+
*/
|
|
1402
|
+
maximumHours: number;
|
|
1403
|
+
/**
|
|
1404
|
+
* The maximum value allowed for a request condition or risk setting.
|
|
1405
|
+
*/
|
|
1406
|
+
maximumWeeks: number;
|
|
1407
|
+
/**
|
|
1408
|
+
* Whether accessDurationSetting must be included in the request conditions or risk settings for the specified resource.
|
|
1409
|
+
*/
|
|
1410
|
+
required: boolean;
|
|
1411
|
+
/**
|
|
1412
|
+
* Access duration settings that are eligible to be added to a request condition or risk settings for the specified resource.
|
|
1413
|
+
*/
|
|
1414
|
+
supportedTypes?: outputs.GetRequestSettingResourceValidAccessDurationSettingsSupportedType[];
|
|
1415
|
+
}
|
|
1416
|
+
export interface GetRequestSettingResourceValidAccessDurationSettingsSupportedType {
|
|
1417
|
+
type: string;
|
|
1418
|
+
}
|
|
1419
|
+
export interface GetRequestSettingResourceValidAccessScopeSetting {
|
|
1420
|
+
type: string;
|
|
1421
|
+
}
|
|
1422
|
+
export interface GetRequestSettingResourceValidRequesterSetting {
|
|
1423
|
+
type: string;
|
|
1424
|
+
}
|
|
1425
|
+
export interface GetRequestV2Requested {
|
|
1426
|
+
/**
|
|
1427
|
+
* The ID of the access scope associated with the resource.
|
|
1428
|
+
*/
|
|
1429
|
+
accessScopeId: string;
|
|
1430
|
+
/**
|
|
1431
|
+
* The access scope type.
|
|
1432
|
+
*/
|
|
1433
|
+
accessScopeType: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* The ID of the resource catalog entry.
|
|
1436
|
+
*/
|
|
1437
|
+
entryId: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* The ID of the requested resource.
|
|
1440
|
+
*/
|
|
1441
|
+
resourceId: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* The requested resource type.
|
|
1444
|
+
*/
|
|
1445
|
+
resourceType: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* The type of the resource.
|
|
1448
|
+
*/
|
|
1449
|
+
type: string;
|
|
1450
|
+
}
|
|
1451
|
+
export interface GetRequestV2RequestedBy {
|
|
1452
|
+
/**
|
|
1453
|
+
* The Okta user id.
|
|
1454
|
+
*/
|
|
1455
|
+
externalId: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* The type of principal.
|
|
1458
|
+
*/
|
|
1459
|
+
type: string;
|
|
1460
|
+
}
|
|
1461
|
+
export interface GetRequestV2RequestedFor {
|
|
1462
|
+
/**
|
|
1463
|
+
* The ID of the Okta user.
|
|
1464
|
+
*/
|
|
1465
|
+
externalId: string;
|
|
1466
|
+
/**
|
|
1467
|
+
* The type of principal.
|
|
1468
|
+
*/
|
|
1469
|
+
type: string;
|
|
1470
|
+
}
|
|
1471
|
+
export interface GetReviewAllReviewerLevel {
|
|
1472
|
+
/**
|
|
1473
|
+
* The ISO 8601 formatted date and time when the resource was created.
|
|
1474
|
+
*/
|
|
1475
|
+
created: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* The id of user who created the resource.
|
|
1478
|
+
*/
|
|
1479
|
+
createdBy: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* The decision taken by the reviewer. Will be `UNASSIGNED` if no decision is made.
|
|
1482
|
+
*/
|
|
1483
|
+
decision: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* The ID of review.
|
|
1486
|
+
*/
|
|
1487
|
+
id: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* The ISO 8601 formatted date and time when the object was last updated.
|
|
1490
|
+
*/
|
|
1491
|
+
lastUpdated: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* The id of user who last updated the object.
|
|
1494
|
+
*/
|
|
1495
|
+
lastUpdatedBy: string;
|
|
1496
|
+
reviewerGroupProfile?: outputs.GetReviewAllReviewerLevelReviewerGroupProfile;
|
|
1497
|
+
reviewerLevel: string;
|
|
1498
|
+
reviewerProfile?: outputs.GetReviewAllReviewerLevelReviewerProfile;
|
|
1499
|
+
/**
|
|
1500
|
+
* The type of reviewer to which the review is assigned.
|
|
1501
|
+
*/
|
|
1502
|
+
reviewerType: string;
|
|
1503
|
+
}
|
|
1504
|
+
export interface GetReviewAllReviewerLevelReviewerGroupProfile {
|
|
1505
|
+
globalName: string;
|
|
1506
|
+
groupId: string;
|
|
1507
|
+
groupType: string;
|
|
1508
|
+
name: string;
|
|
1509
|
+
}
|
|
1510
|
+
export interface GetReviewAllReviewerLevelReviewerProfile {
|
|
1511
|
+
email: string;
|
|
1512
|
+
firstName: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* The ID of review.
|
|
1515
|
+
*/
|
|
1516
|
+
id: string;
|
|
1517
|
+
lastName: string;
|
|
1518
|
+
status: string;
|
|
1519
|
+
}
|
|
1520
|
+
export interface GetReviewEntitlementBundle {
|
|
1521
|
+
/**
|
|
1522
|
+
* The ID of review.
|
|
1523
|
+
*/
|
|
1524
|
+
id: string;
|
|
1525
|
+
name: string;
|
|
1526
|
+
}
|
|
1527
|
+
export interface GetReviewEntitlementValue {
|
|
1528
|
+
/**
|
|
1529
|
+
* The ID of review.
|
|
1530
|
+
*/
|
|
1531
|
+
id: string;
|
|
1532
|
+
name: string;
|
|
1533
|
+
}
|
|
1534
|
+
export interface GetReviewLinks {
|
|
1535
|
+
reassignReviewHref: string;
|
|
1536
|
+
selfHref: string;
|
|
1537
|
+
}
|
|
1538
|
+
export interface GetReviewNote {
|
|
1539
|
+
/**
|
|
1540
|
+
* The ID of review.
|
|
1541
|
+
*/
|
|
1542
|
+
id: string;
|
|
1543
|
+
note: string;
|
|
1544
|
+
}
|
|
1545
|
+
export interface GetReviewPrincipalProfile {
|
|
1546
|
+
email: string;
|
|
1547
|
+
firstName: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* The ID of review.
|
|
1550
|
+
*/
|
|
1551
|
+
id: string;
|
|
1552
|
+
lastName: string;
|
|
1553
|
+
login: string;
|
|
1554
|
+
status: string;
|
|
1555
|
+
}
|
|
1556
|
+
export interface GetReviewReviewerProfile {
|
|
1557
|
+
email: string;
|
|
1558
|
+
firstName: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* The ID of review.
|
|
1561
|
+
*/
|
|
1562
|
+
id: string;
|
|
1563
|
+
lastName: string;
|
|
1564
|
+
login: string;
|
|
1565
|
+
status: string;
|
|
1566
|
+
}
|
|
449
1567
|
export interface GetTemplatesEmailTemplate {
|
|
450
1568
|
/**
|
|
451
1569
|
* Link relations for this object - JSON HAL - Discoverable resources related to the email template
|
|
@@ -631,6 +1749,149 @@ export interface PreviewSigninPageWidgetCustomizations {
|
|
|
631
1749
|
usernameLabel?: string;
|
|
632
1750
|
widgetGeneration: string;
|
|
633
1751
|
}
|
|
1752
|
+
export interface RateLimitingUseCaseModeOverrides {
|
|
1753
|
+
loginPage?: string;
|
|
1754
|
+
oauth2Authorize?: string;
|
|
1755
|
+
oieAppIntent?: string;
|
|
1756
|
+
}
|
|
1757
|
+
export interface RequestConditionAccessDurationSettings {
|
|
1758
|
+
/**
|
|
1759
|
+
* The duration set by the admin for access durations. Use ISO8061 notation for duration values.
|
|
1760
|
+
*/
|
|
1761
|
+
duration?: string;
|
|
1762
|
+
type?: string;
|
|
1763
|
+
}
|
|
1764
|
+
export interface RequestConditionAccessScopeSettings {
|
|
1765
|
+
/**
|
|
1766
|
+
* List of groups/entitlement bundles.
|
|
1767
|
+
*/
|
|
1768
|
+
ids?: outputs.RequestConditionAccessScopeSettingsId[];
|
|
1769
|
+
type: string;
|
|
1770
|
+
}
|
|
1771
|
+
export interface RequestConditionAccessScopeSettingsId {
|
|
1772
|
+
/**
|
|
1773
|
+
* Request condition id.
|
|
1774
|
+
*/
|
|
1775
|
+
id?: string;
|
|
1776
|
+
}
|
|
1777
|
+
export interface RequestConditionRequesterSettings {
|
|
1778
|
+
/**
|
|
1779
|
+
* List of teams/groups ids.
|
|
1780
|
+
*/
|
|
1781
|
+
ids?: outputs.RequestConditionRequesterSettingsId[];
|
|
1782
|
+
type: string;
|
|
1783
|
+
}
|
|
1784
|
+
export interface RequestConditionRequesterSettingsId {
|
|
1785
|
+
/**
|
|
1786
|
+
* Request condition id.
|
|
1787
|
+
*/
|
|
1788
|
+
id?: string;
|
|
1789
|
+
}
|
|
1790
|
+
export interface RequestSettingResourceRequestOnBehalfOfSettings {
|
|
1791
|
+
/**
|
|
1792
|
+
* Indicates that users who can request this resource could also request for another requester of the same resource. This property can only be true.
|
|
1793
|
+
*/
|
|
1794
|
+
allowed: boolean;
|
|
1795
|
+
/**
|
|
1796
|
+
* Which requesters the resource requester can request on behalf of. Enum: `DIRECT_REPORT`.
|
|
1797
|
+
*/
|
|
1798
|
+
onlyFors?: outputs.RequestSettingResourceRequestOnBehalfOfSettingsOnlyFor[];
|
|
1799
|
+
}
|
|
1800
|
+
export interface RequestSettingResourceRequestOnBehalfOfSettingsOnlyFor {
|
|
1801
|
+
/**
|
|
1802
|
+
* Which requesters the resource requester can request on behalf of. If onlyFor is not specified then any requester may request a resource on the behalf of any other user
|
|
1803
|
+
*/
|
|
1804
|
+
type: string;
|
|
1805
|
+
}
|
|
1806
|
+
export interface RequestSettingResourceRiskSettings {
|
|
1807
|
+
/**
|
|
1808
|
+
* Default risk settings that are valid for an access request when a risk has been detected for the resource and requesting user.
|
|
1809
|
+
*/
|
|
1810
|
+
defaultSetting?: outputs.RequestSettingResourceRiskSettingsDefaultSetting;
|
|
1811
|
+
}
|
|
1812
|
+
export interface RequestSettingResourceRiskSettingsDefaultSetting {
|
|
1813
|
+
/**
|
|
1814
|
+
* Settings that control who may specify the access duration allowed by this request condition or risk settings, as well as what duration may be requested.
|
|
1815
|
+
*/
|
|
1816
|
+
accessDurationSettings?: outputs.RequestSettingResourceRiskSettingsDefaultSettingAccessDurationSettings;
|
|
1817
|
+
/**
|
|
1818
|
+
* The ID of the approval sequence.
|
|
1819
|
+
*/
|
|
1820
|
+
approvalSequenceId?: string;
|
|
1821
|
+
errors: string[];
|
|
1822
|
+
requestSubmissionType: string;
|
|
1823
|
+
}
|
|
1824
|
+
export interface RequestSettingResourceRiskSettingsDefaultSettingAccessDurationSettings {
|
|
1825
|
+
/**
|
|
1826
|
+
* The duration set by the admin for access durations. Use ISO8061 notation for duration values.
|
|
1827
|
+
*/
|
|
1828
|
+
duration?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* Enum: `ADMIN_FIXED_DURATION`, `REQUESTER_SPECIFIED_DURATION`.
|
|
1831
|
+
*/
|
|
1832
|
+
type?: string;
|
|
1833
|
+
}
|
|
1834
|
+
export interface RequestV2Requested {
|
|
1835
|
+
/**
|
|
1836
|
+
* The ID of the access scope associated with the resource.
|
|
1837
|
+
*/
|
|
1838
|
+
accessScopeId: string;
|
|
1839
|
+
/**
|
|
1840
|
+
* The access scope type.
|
|
1841
|
+
*/
|
|
1842
|
+
accessScopeType: string;
|
|
1843
|
+
/**
|
|
1844
|
+
* The ID of the resource catalog entry.
|
|
1845
|
+
*/
|
|
1846
|
+
entryId: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* The ID of the requested resource.
|
|
1849
|
+
*/
|
|
1850
|
+
resourceId: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* The requested resource type.
|
|
1853
|
+
*/
|
|
1854
|
+
resourceType: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The type of the resource.
|
|
1857
|
+
*/
|
|
1858
|
+
type: string;
|
|
1859
|
+
}
|
|
1860
|
+
export interface RequestV2RequestedFor {
|
|
1861
|
+
/**
|
|
1862
|
+
* The ID of the Okta user.
|
|
1863
|
+
*/
|
|
1864
|
+
externalId: string;
|
|
1865
|
+
/**
|
|
1866
|
+
* The type of principal.
|
|
1867
|
+
*/
|
|
1868
|
+
type: string;
|
|
1869
|
+
}
|
|
1870
|
+
export interface RequestV2RequesterFieldValue {
|
|
1871
|
+
/**
|
|
1872
|
+
* The ID of a requester field.
|
|
1873
|
+
*/
|
|
1874
|
+
id?: string;
|
|
1875
|
+
/**
|
|
1876
|
+
* A human-readable description of requester field.
|
|
1877
|
+
*/
|
|
1878
|
+
label?: string;
|
|
1879
|
+
/**
|
|
1880
|
+
* Type of value for the requester field.
|
|
1881
|
+
*/
|
|
1882
|
+
type?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* The value of requester field, which depends on the type of the field.
|
|
1885
|
+
*/
|
|
1886
|
+
value?: string;
|
|
1887
|
+
/**
|
|
1888
|
+
* The values of requester field with the type MULTISELECT. If the field type is MULTISELECT, this property is required.
|
|
1889
|
+
*/
|
|
1890
|
+
values?: outputs.RequestV2RequesterFieldValueValue[];
|
|
1891
|
+
}
|
|
1892
|
+
export interface RequestV2RequesterFieldValueValue {
|
|
1893
|
+
value?: string;
|
|
1894
|
+
}
|
|
634
1895
|
export interface TemplateSmsTranslation {
|
|
635
1896
|
/**
|
|
636
1897
|
* The language to map the template to.
|