@pulumi/auth0 2.14.0-alpha.1663280530 → 2.14.0-alpha.1666810964

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.
Files changed (104) hide show
  1. package/action.d.ts +25 -72
  2. package/action.js +2 -50
  3. package/action.js.map +1 -1
  4. package/attackProtection.d.ts +9 -8
  5. package/attackProtection.js +4 -4
  6. package/attackProtection.js.map +1 -1
  7. package/branding.d.ts +31 -30
  8. package/branding.js +14 -8
  9. package/branding.js.map +1 -1
  10. package/brandingTheme.d.ts +156 -0
  11. package/brandingTheme.js +165 -0
  12. package/brandingTheme.js.map +1 -0
  13. package/client.d.ts +145 -126
  14. package/client.js +26 -22
  15. package/client.js.map +1 -1
  16. package/clientGrant.d.ts +12 -13
  17. package/clientGrant.js +3 -4
  18. package/clientGrant.js.map +1 -1
  19. package/config/vars.d.ts +22 -0
  20. package/config/vars.js +6 -0
  21. package/config/vars.js.map +1 -1
  22. package/connection.d.ts +256 -41
  23. package/connection.js +236 -4
  24. package/connection.js.map +1 -1
  25. package/customDomain.d.ts +42 -18
  26. package/customDomain.js +6 -3
  27. package/customDomain.js.map +1 -1
  28. package/customDomainVerification.d.ts +15 -9
  29. package/customDomainVerification.js +4 -4
  30. package/customDomainVerification.js.map +1 -1
  31. package/email.d.ts +37 -18
  32. package/email.js +23 -5
  33. package/email.js.map +1 -1
  34. package/emailTemplate.d.ts +29 -32
  35. package/emailTemplate.js +2 -5
  36. package/emailTemplate.js.map +1 -1
  37. package/getClient.d.ts +111 -6
  38. package/getClient.js +3 -1
  39. package/getClient.js.map +1 -1
  40. package/getGlobalClient.d.ts +98 -31
  41. package/getGlobalClient.js +3 -11
  42. package/getGlobalClient.js.map +1 -1
  43. package/getTenant.d.ts +3 -3
  44. package/getTenant.js +1 -1
  45. package/globalClient.d.ts +333 -2
  46. package/globalClient.js +7 -3
  47. package/globalClient.js.map +1 -1
  48. package/guardian.d.ts +32 -56
  49. package/guardian.js +3 -4
  50. package/guardian.js.map +1 -1
  51. package/hook.d.ts +12 -18
  52. package/hook.js +9 -10
  53. package/hook.js.map +1 -1
  54. package/index.d.ts +91 -30
  55. package/index.js +94 -101
  56. package/index.js.map +1 -1
  57. package/logStream.d.ts +34 -18
  58. package/logStream.js +17 -2
  59. package/logStream.js.map +1 -1
  60. package/organization.d.ts +22 -55
  61. package/organization.js +8 -17
  62. package/organization.js.map +1 -1
  63. package/organizationConnection.d.ts +7 -5
  64. package/organizationConnection.js +7 -5
  65. package/organizationConnection.js.map +1 -1
  66. package/organizationMember.d.ts +27 -15
  67. package/organizationMember.js +18 -6
  68. package/organizationMember.js.map +1 -1
  69. package/package.json +2 -2
  70. package/package.json.dev +2 -2
  71. package/prompt.d.ts +12 -12
  72. package/prompt.js +4 -4
  73. package/promptCustomText.d.ts +8 -9
  74. package/promptCustomText.js +2 -3
  75. package/promptCustomText.js.map +1 -1
  76. package/provider.d.ts +41 -0
  77. package/provider.js +1 -0
  78. package/provider.js.map +1 -1
  79. package/resourceServer.d.ts +47 -46
  80. package/resourceServer.js +4 -1
  81. package/resourceServer.js.map +1 -1
  82. package/role.d.ts +13 -17
  83. package/role.js +2 -4
  84. package/role.js.map +1 -1
  85. package/rule.d.ts +19 -25
  86. package/rule.js +6 -12
  87. package/rule.js.map +1 -1
  88. package/ruleConfig.d.ts +12 -14
  89. package/ruleConfig.js +9 -9
  90. package/ruleConfig.js.map +1 -1
  91. package/tenant.d.ts +91 -80
  92. package/tenant.js +35 -25
  93. package/tenant.js.map +1 -1
  94. package/triggerBinding.d.ts +19 -26
  95. package/triggerBinding.js +11 -16
  96. package/triggerBinding.js.map +1 -1
  97. package/types/index.js.map +1 -1
  98. package/types/input.d.ts +488 -425
  99. package/types/output.d.ts +500 -435
  100. package/user.d.ts +87 -44
  101. package/user.js +6 -6
  102. package/user.js.map +1 -1
  103. package/utilities.js +13 -1
  104. package/utilities.js.map +1 -1
package/types/output.d.ts CHANGED
@@ -1,11 +1,11 @@
1
- import { output as outputs } from "../types";
1
+ import * as outputs from "../types/output";
2
2
  export interface ActionDependency {
3
3
  /**
4
- * Secret name.
4
+ * Dependency name, e.g. `lodash`.
5
5
  */
6
6
  name: string;
7
7
  /**
8
- * Trigger version.
8
+ * Dependency version, e.g. `latest` or `4.17.21`.
9
9
  */
10
10
  version: string;
11
11
  }
@@ -21,11 +21,11 @@ export interface ActionSecret {
21
21
  }
22
22
  export interface ActionSupportedTriggers {
23
23
  /**
24
- * Trigger ID.
24
+ * The trigger ID.
25
25
  */
26
26
  id: string;
27
27
  /**
28
- * Trigger version.
28
+ * The trigger version. This regulates which `runtime` versions are supported.
29
29
  */
30
30
  version: string;
31
31
  }
@@ -35,7 +35,7 @@ export interface AttackProtectionBreachedPasswordDetection {
35
35
  */
36
36
  adminNotificationFrequencies: string[];
37
37
  /**
38
- * Whether or not breached password detection is active.
38
+ * Whether breached password detection is active.
39
39
  */
40
40
  enabled?: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export interface AttackProtectionBreachedPasswordDetection {
43
43
  */
44
44
  method: string;
45
45
  /**
46
- * Action to take when a breached password is detected. Possible values: `block`, `userNotification`, `adminNotification`.
46
+ * Action to take when a breached password is detected.
47
47
  */
48
48
  shields: string[];
49
49
  }
@@ -53,7 +53,7 @@ export interface AttackProtectionBruteForceProtection {
53
53
  */
54
54
  allowlists: string[];
55
55
  /**
56
- * Whether or not breached password detection is active.
56
+ * Whether brute force attack protections are active.
57
57
  */
58
58
  enabled?: boolean;
59
59
  /**
@@ -61,11 +61,11 @@ export interface AttackProtectionBruteForceProtection {
61
61
  */
62
62
  maxAttempts: number;
63
63
  /**
64
- * Determines whether or not IP address is used when counting failed attempts. Possible values: `countPerIdentifierAndIp` or `countPerIdentifier`.
64
+ * Determines whether the IP address is used when counting failed attempts. Possible values: `countPerIdentifierAndIp` or `countPerIdentifier`.
65
65
  */
66
66
  mode: string;
67
67
  /**
68
- * Action to take when a breached password is detected. Possible values: `block`, `userNotification`, `adminNotification`.
68
+ * Action to take when a brute force protection threshold is violated. Possible values: `block`, `userNotification`
69
69
  */
70
70
  shields: string[];
71
71
  }
@@ -75,7 +75,7 @@ export interface AttackProtectionSuspiciousIpThrottling {
75
75
  */
76
76
  allowlists: string[];
77
77
  /**
78
- * Whether or not breached password detection is active.
78
+ * Whether suspicious IP throttling attack protections are active.
79
79
  */
80
80
  enabled?: boolean;
81
81
  /**
@@ -87,399 +87,442 @@ export interface AttackProtectionSuspiciousIpThrottling {
87
87
  */
88
88
  preUserRegistration: outputs.AttackProtectionSuspiciousIpThrottlingPreUserRegistration;
89
89
  /**
90
- * Action to take when a breached password is detected. Possible values: `block`, `userNotification`, `adminNotification`.
90
+ * Action to take when a suspicious IP throttling threshold is violated. Possible values: `block`, `adminNotification`
91
91
  */
92
92
  shields: string[];
93
93
  }
94
94
  export interface AttackProtectionSuspiciousIpThrottlingPreLogin {
95
- /**
96
- * Maximum number of unsuccessful attempts. Only available on public tenants.
97
- */
98
95
  maxAttempts: number;
99
96
  rate: number;
100
97
  }
101
98
  export interface AttackProtectionSuspiciousIpThrottlingPreUserRegistration {
102
- /**
103
- * Maximum number of unsuccessful attempts. Only available on public tenants.
104
- */
105
99
  maxAttempts: number;
106
100
  rate: number;
107
101
  }
108
102
  export interface BrandingColors {
109
103
  /**
110
- * String, Hexadecimal. Background color of login pages.
104
+ * Background color of login pages in hexadecimal.
111
105
  */
112
106
  pageBackground: string;
113
107
  /**
114
- * String, Hexadecimal. Primary button background color.
108
+ * Primary button background color in hexadecimal.
115
109
  */
116
110
  primary: string;
117
111
  }
118
112
  export interface BrandingFont {
119
113
  /**
120
- * String. URL for the custom font.
114
+ * URL for the custom font.
121
115
  */
122
116
  url: string;
123
117
  }
118
+ export interface BrandingThemeBorders {
119
+ /**
120
+ * Button border radius. Value needs to be between `1` and `10`.
121
+ */
122
+ buttonBorderRadius: number;
123
+ /**
124
+ * Button border weight. Value needs to be between `0` and `10`.
125
+ */
126
+ buttonBorderWeight: number;
127
+ /**
128
+ * Buttons style. Available options: `pill`, `rounded`, `sharp`.
129
+ */
130
+ buttonsStyle: string;
131
+ /**
132
+ * Input border radius. Value needs to be between `0` and `10`.
133
+ */
134
+ inputBorderRadius: number;
135
+ /**
136
+ * Input border weight. Value needs to be between `0` and `3`.
137
+ */
138
+ inputBorderWeight: number;
139
+ /**
140
+ * Inputs style. Available options: `pill`, `rounded`, `sharp`.
141
+ */
142
+ inputsStyle: string;
143
+ /**
144
+ * Show widget shadow.
145
+ */
146
+ showWidgetShadow: boolean;
147
+ /**
148
+ * Widget border weight. Value needs to be between `0` and `10`.
149
+ */
150
+ widgetBorderWeight: number;
151
+ /**
152
+ * Widget corner radius. Value needs to be between `0` and `50`.
153
+ */
154
+ widgetCornerRadius: number;
155
+ }
156
+ export interface BrandingThemeColors {
157
+ /**
158
+ * Base focus color.
159
+ */
160
+ baseFocusColor?: string;
161
+ /**
162
+ * Base hover color.
163
+ */
164
+ baseHoverColor?: string;
165
+ /**
166
+ * Body text.
167
+ */
168
+ bodyText: string;
169
+ /**
170
+ * Error.
171
+ */
172
+ error: string;
173
+ /**
174
+ * Header.
175
+ */
176
+ header: string;
177
+ /**
178
+ * Icons.
179
+ */
180
+ icons: string;
181
+ /**
182
+ * Input background.
183
+ */
184
+ inputBackground: string;
185
+ /**
186
+ * Input border.
187
+ */
188
+ inputBorder: string;
189
+ /**
190
+ * Input filled text.
191
+ */
192
+ inputFilledText: string;
193
+ /**
194
+ * Input labels & placeholders.
195
+ */
196
+ inputLabelsPlaceholders: string;
197
+ /**
198
+ * Links & focused components.
199
+ */
200
+ linksFocusedComponents: string;
201
+ /**
202
+ * Primary button.
203
+ */
204
+ primaryButton: string;
205
+ /**
206
+ * Primary button label.
207
+ */
208
+ primaryButtonLabel: string;
209
+ /**
210
+ * Secondary button border.
211
+ */
212
+ secondaryButtonBorder: string;
213
+ /**
214
+ * Secondary button label.
215
+ */
216
+ secondaryButtonLabel: string;
217
+ /**
218
+ * Success.
219
+ */
220
+ success: string;
221
+ /**
222
+ * Widget background.
223
+ */
224
+ widgetBackground: string;
225
+ /**
226
+ * Widget border.
227
+ */
228
+ widgetBorder: string;
229
+ }
230
+ export interface BrandingThemeFonts {
231
+ /**
232
+ * Body text.
233
+ */
234
+ bodyText: outputs.BrandingThemeFontsBodyText;
235
+ /**
236
+ * Buttons text.
237
+ */
238
+ buttonsText: outputs.BrandingThemeFontsButtonsText;
239
+ /**
240
+ * Font URL.
241
+ */
242
+ fontUrl: string;
243
+ /**
244
+ * Input labels.
245
+ */
246
+ inputLabels: outputs.BrandingThemeFontsInputLabels;
247
+ /**
248
+ * Links.
249
+ */
250
+ links: outputs.BrandingThemeFontsLinks;
251
+ /**
252
+ * Links style.
253
+ */
254
+ linksStyle: string;
255
+ /**
256
+ * Reference text size. Value needs to be between `12` and `24`.
257
+ */
258
+ referenceTextSize: number;
259
+ /**
260
+ * Subtitle.
261
+ */
262
+ subtitle: outputs.BrandingThemeFontsSubtitle;
263
+ /**
264
+ * Title.
265
+ */
266
+ title: outputs.BrandingThemeFontsTitle;
267
+ }
268
+ export interface BrandingThemeFontsBodyText {
269
+ bold: boolean;
270
+ size: number;
271
+ }
272
+ export interface BrandingThemeFontsButtonsText {
273
+ bold: boolean;
274
+ size: number;
275
+ }
276
+ export interface BrandingThemeFontsInputLabels {
277
+ bold: boolean;
278
+ size: number;
279
+ }
280
+ export interface BrandingThemeFontsLinks {
281
+ bold: boolean;
282
+ size: number;
283
+ }
284
+ export interface BrandingThemeFontsSubtitle {
285
+ bold: boolean;
286
+ size: number;
287
+ }
288
+ export interface BrandingThemeFontsTitle {
289
+ bold: boolean;
290
+ size: number;
291
+ }
292
+ export interface BrandingThemePageBackground {
293
+ /**
294
+ * Background color.
295
+ */
296
+ backgroundColor: string;
297
+ /**
298
+ * Background image url.
299
+ */
300
+ backgroundImageUrl: string;
301
+ /**
302
+ * Page layout. Available options: `center`, `left`, `right`.
303
+ */
304
+ pageLayout: string;
305
+ }
306
+ export interface BrandingThemeWidget {
307
+ /**
308
+ * Header text alignment. Available options: `center`, `left`, `right`.
309
+ */
310
+ headerTextAlignment: string;
311
+ /**
312
+ * Logo height. Value needs to be between `1` and `100`.
313
+ */
314
+ logoHeight: number;
315
+ /**
316
+ * Logo position. Available options: `center`, `left`, `right`, `none`.
317
+ */
318
+ logoPosition: string;
319
+ /**
320
+ * Logo url.
321
+ */
322
+ logoUrl: string;
323
+ /**
324
+ * Social buttons layout. Available options: `bottom`, `top`.
325
+ */
326
+ socialButtonsLayout: string;
327
+ }
124
328
  export interface BrandingUniversalLogin {
125
329
  /**
126
- * String, body of login pages.
330
+ * The body of login pages.
127
331
  */
128
332
  body: string;
129
333
  }
130
334
  export interface ClientAddons {
131
- /**
132
- * String
133
- */
134
335
  aws?: {
135
336
  [key: string]: any;
136
337
  };
137
- /**
138
- * String
139
- */
140
338
  azureBlob?: {
141
339
  [key: string]: any;
142
340
  };
143
- /**
144
- * String
145
- */
146
341
  azureSb?: {
147
342
  [key: string]: any;
148
343
  };
149
- /**
150
- * String
151
- */
152
344
  box?: {
153
345
  [key: string]: any;
154
346
  };
155
- /**
156
- * String
157
- */
158
347
  cloudbees?: {
159
348
  [key: string]: any;
160
349
  };
161
- /**
162
- * String
163
- */
164
350
  concur?: {
165
351
  [key: string]: any;
166
352
  };
167
- /**
168
- * String
169
- */
170
353
  dropbox?: {
171
354
  [key: string]: any;
172
355
  };
173
- /**
174
- * String
175
- */
176
356
  echosign?: {
177
357
  [key: string]: any;
178
358
  };
179
- /**
180
- * String
181
- */
182
359
  egnyte?: {
183
360
  [key: string]: any;
184
361
  };
185
- /**
186
- * String
187
- */
188
362
  firebase?: {
189
363
  [key: string]: any;
190
364
  };
191
- /**
192
- * String
193
- */
194
365
  layer?: {
195
366
  [key: string]: any;
196
367
  };
197
- /**
198
- * String
199
- */
200
368
  mscrm?: {
201
369
  [key: string]: any;
202
370
  };
203
- /**
204
- * String
205
- */
206
371
  newrelic?: {
207
372
  [key: string]: any;
208
373
  };
209
- /**
210
- * String
211
- */
212
374
  office365?: {
213
375
  [key: string]: any;
214
376
  };
215
- /**
216
- * String
217
- */
218
377
  rms?: {
219
378
  [key: string]: any;
220
379
  };
221
- /**
222
- * String
223
- */
224
380
  salesforce?: {
225
381
  [key: string]: any;
226
382
  };
227
- /**
228
- * String
229
- */
230
383
  salesforceApi?: {
231
384
  [key: string]: any;
232
385
  };
233
- /**
234
- * String
235
- */
236
386
  salesforceSandboxApi?: {
237
387
  [key: string]: any;
238
388
  };
239
389
  /**
240
- * List(Resource). Configuration settings for a SAML add-on. For details, see SAML.
241
- */
242
- samlp: outputs.ClientAddonsSamlp;
243
- /**
244
- * String
390
+ * Configuration settings for a SAML add-on.
245
391
  */
392
+ samlp?: outputs.ClientAddonsSamlp;
246
393
  sapApi?: {
247
394
  [key: string]: any;
248
395
  };
249
- /**
250
- * String
251
- */
252
396
  sentry?: {
253
397
  [key: string]: any;
254
398
  };
255
- /**
256
- * String
257
- */
258
399
  sharepoint?: {
259
400
  [key: string]: any;
260
401
  };
261
- /**
262
- * String
263
- */
264
402
  slack?: {
265
403
  [key: string]: any;
266
404
  };
267
- /**
268
- * String
269
- */
270
405
  springcm?: {
271
406
  [key: string]: any;
272
407
  };
273
- /**
274
- * String
275
- */
276
408
  wams?: {
277
409
  [key: string]: any;
278
410
  };
279
411
  /**
280
- * String
412
+ * WS-Fed (WIF) addon indicator. Actual configuration is stored in callback and `clientAliases` properties on the client.
281
413
  */
282
414
  wsfed?: {
283
415
  [key: string]: any;
284
416
  };
285
- /**
286
- * String
287
- */
288
417
  zendesk?: {
289
418
  [key: string]: any;
290
419
  };
291
- /**
292
- * String
293
- */
294
420
  zoom?: {
295
421
  [key: string]: any;
296
422
  };
297
423
  }
298
424
  export interface ClientAddonsSamlp {
299
- /**
300
- * String. Audience of the SAML Assertion. Default will be the Issuer on SAMLRequest.
301
- */
302
425
  audience?: string;
303
- /**
304
- * String. Class reference of the authentication context.
305
- */
306
426
  authnContextClassRef?: string;
307
- /**
308
- * String. Protocol binding used for SAML logout responses.
309
- */
310
427
  binding?: string;
311
- /**
312
- * Boolean, (Default=true) Indicates whether or not a UPN claim should be created.
313
- */
314
428
  createUpnClaim?: boolean;
315
- /**
316
- * String. Destination of the SAML Response. If not specified, it will be AssertionConsumerUrlof SAMLRequest or Callback URL if there was no SAMLRequest.
317
- */
318
429
  destination?: string;
319
- /**
320
- * String, (Default=`sha1`). Algorithm used to calculate the digest of the SAML Assertion or response. Options include `defaultsha1` and `sha256`.
321
- */
322
430
  digestAlgorithm?: string;
323
- /**
324
- * Boolean,(Default=true). Indicates whether or not we should infer the NameFormat based on the attribute name. If set to false, the attribute NameFormat is not set in the assertion.
325
- */
326
431
  includeAttributeNameFormat?: boolean;
327
- /**
328
- * Integer, (Default=3600). Number of seconds during which the token is valid.
329
- */
432
+ issuer?: string;
330
433
  lifetimeInSeconds?: number;
331
- /**
332
- * Map(Resource). Configuration settings for logout. For details, see Logout.
333
- */
334
434
  logout?: {
335
435
  [key: string]: any;
336
436
  };
337
- /**
338
- * Boolean, (Default=true). Indicates whether or not to add additional identity information in the token, such as the provider used and the access_token, if available.
339
- */
340
437
  mapIdentities?: boolean;
341
- /**
342
- * Boolean, (Default=false). Indicates whether or not to add a prefix of `http://schema.auth0.com` to any claims that are not mapped to the common profile when passed through in the output assertion.
343
- */
344
438
  mapUnknownClaimsAsIs?: boolean;
345
- /**
346
- * Map(String). Mappings between the Auth0 user profile property name (`name`) and the output attributes on the SAML attribute in the assertion (`value`).
347
- */
348
439
  mappings?: {
349
440
  [key: string]: any;
350
441
  };
351
- /**
352
- * String, (Default=`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`). Format of the name identifier.
353
- */
354
442
  nameIdentifierFormat?: string;
355
- /**
356
- * List(String). Attributes that can be used for Subject/NameID. Auth0 will try each of the attributes of this array in order and use the first value it finds.
357
- */
358
443
  nameIdentifierProbes?: string[];
359
- /**
360
- * Boolean, (Default=true). Indicates whether or not to passthrough claims that are not mapped to the common profile in the output assertion.
361
- */
362
444
  passthroughClaimsWithNoMapping?: boolean;
363
- /**
364
- * String. Recipient of the SAML Assertion (SubjectConfirmationData). Default is AssertionConsumerUrl on SAMLRequest or Callback URL if no SAMLRequest was sent.
365
- */
366
445
  recipient?: string;
367
- /**
368
- * Boolean. Indicates whether or not the SAML Response should be signed instead of the SAML Assertion.
369
- */
370
446
  signResponse?: boolean;
371
- /**
372
- * String, (Default=`rsa-sha1`). Algorithm used to sign the SAML Assertion or response. Options include `rsa-sha1` and `rsa-sha256`.
373
- */
374
447
  signatureAlgorithm?: string;
375
- /**
376
- * String. Optionally indicates the public key certificate used to validate SAML requests. If set, SAML requests will be required to be signed. A sample value would be `-----BEGIN PUBLIC KEY-----\nMIGf...bpP/t3\n+JGNGIRMj1hF1rnb6QIDAQAB\n-----END PUBLIC KEY-----\n`.
377
- */
378
448
  signingCert?: string;
379
- /**
380
- * Boolean, (Default=true). Indicates whether or not we should infer the `xs:type` of the element. Types include `xs:string`, `xs:boolean`, `xs:double`, and `xs:anyType`. When set to false, all `xs:type` are `xs:anyType`.
381
- */
382
449
  typedAttributes?: boolean;
383
450
  }
384
451
  export interface ClientJwtConfiguration {
385
452
  /**
386
- * String. Algorithm used to sign JWTs.
453
+ * Algorithm used to sign JWTs.
387
454
  */
388
455
  alg?: string;
389
456
  /**
390
- * Integer. Number of seconds during which the JWT will be valid.
457
+ * Number of seconds during which the JWT will be valid.
391
458
  */
392
459
  lifetimeInSeconds: number;
393
460
  /**
394
- * Map(String). Permissions (scopes) included in JWTs.
461
+ * Permissions (scopes) included in JWTs.
395
462
  */
396
463
  scopes?: {
397
464
  [key: string]: string;
398
465
  };
399
466
  /**
400
- * Boolean. Indicates whether or not the client secret is base64 encoded.
467
+ * Indicates whether the client secret is Base64-encoded.
401
468
  */
402
469
  secretEncoded: boolean;
403
470
  }
404
471
  export interface ClientMobile {
405
472
  /**
406
- * List(Resource). Configuration settings for Android native apps. For details, see Android.
473
+ * Configuration settings for Android native apps.
407
474
  */
408
- android?: outputs.ClientMobileAndroid;
475
+ android: outputs.ClientMobileAndroid;
409
476
  /**
410
- * List(Resource). Configuration settings for i0S native apps. For details, see iOS.
477
+ * Configuration settings for i0S native apps.
411
478
  */
412
- ios?: outputs.ClientMobileIos;
479
+ ios: outputs.ClientMobileIos;
413
480
  }
414
481
  export interface ClientMobileAndroid {
415
- /**
416
- * String
417
- */
418
482
  appPackageName?: string;
419
- /**
420
- * List(String)
421
- */
422
483
  sha256CertFingerprints?: string[];
423
484
  }
424
485
  export interface ClientMobileIos {
425
- /**
426
- * String
427
- */
428
486
  appBundleIdentifier?: string;
429
- /**
430
- * String
431
- */
432
487
  teamId?: string;
433
488
  }
434
489
  export interface ClientNativeSocialLogin {
435
- /**
436
- * Resource:
437
- */
438
- apple?: outputs.ClientNativeSocialLoginApple;
439
- /**
440
- * Resources:
441
- */
442
- facebook?: outputs.ClientNativeSocialLoginFacebook;
490
+ apple: outputs.ClientNativeSocialLoginApple;
491
+ facebook: outputs.ClientNativeSocialLoginFacebook;
443
492
  }
444
493
  export interface ClientNativeSocialLoginApple {
445
- /**
446
- * Boolean
447
- */
448
494
  enabled?: boolean;
449
495
  }
450
496
  export interface ClientNativeSocialLoginFacebook {
451
- /**
452
- * Boolean
453
- */
454
497
  enabled?: boolean;
455
498
  }
456
499
  export interface ClientRefreshToken {
457
500
  /**
458
- * String. Options include `expiring`, `non-expiring`. Whether a refresh token will expire based on an absolute lifetime, after which the token can no longer be used. If rotation is `rotating`, this must be set to `expiring`.
501
+ * Options include `expiring`, `non-expiring`. Whether a refresh token will expire based on an absolute lifetime, after which the token can no longer be used. If rotation is `rotating`, this must be set to `expiring`.
459
502
  */
460
503
  expirationType: string;
461
504
  /**
462
- * Integer. The time in seconds after which inactive refresh tokens will expire.
505
+ * The time in seconds after which inactive refresh tokens will expire.
463
506
  */
464
507
  idleTokenLifetime: number;
465
508
  /**
466
- * Boolean, (Default=false) Whether or not inactive refresh tokens should be remain valid indefinitely.
509
+ * Whether inactive refresh tokens should remain valid indefinitely.
467
510
  */
468
511
  infiniteIdleTokenLifetime: boolean;
469
512
  /**
470
- * Boolean, (Default=false) Whether or not refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set
513
+ * Whether refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set.
471
514
  */
472
515
  infiniteTokenLifetime: boolean;
473
516
  /**
474
- * Integer. The amount of time in seconds in which a refresh token may be reused without trigging reuse detection.
517
+ * The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
475
518
  */
476
519
  leeway: number;
477
520
  /**
478
- * String. Options include `rotating`, `non-rotating`. When `rotating`, exchanging a refresh token will cause a new refresh token to be issued and the existing token will be invalidated. This allows for automatic detection of token reuse if the token is leaked.
521
+ * Options include `rotating`, `non-rotating`. When `rotating`, exchanging a refresh token will cause a new refresh token to be issued and the existing token will be invalidated. This allows for automatic detection of token reuse if the token is leaked.
479
522
  */
480
523
  rotationType: string;
481
524
  /**
482
- * Integer. The absolute lifetime of a refresh token in seconds.
525
+ * The absolute lifetime of a refresh token in seconds.
483
526
  */
484
527
  tokenLifetime: number;
485
528
  }
@@ -492,109 +535,142 @@ export interface ConnectionOptions {
492
535
  * List of allowed audiences.
493
536
  */
494
537
  allowedAudiences: string[];
538
+ /**
539
+ * Enable API Access to users.
540
+ */
495
541
  apiEnableUsers?: boolean;
496
542
  /**
497
- * Azure AD app ID.
543
+ * App ID.
498
544
  */
499
545
  appId?: string;
500
546
  /**
501
- * Map(String). Use this to append or override the link parameters (like `scope`, `redirectUri`, `protocol`, `responseType`), when you send a link using email.
547
+ * Query string parameters to be included as part of the generated passwordless email link.
502
548
  */
503
549
  authParams?: {
504
550
  [key: string]: string;
505
551
  };
552
+ /**
553
+ * Authorization endpoint.
554
+ */
506
555
  authorizationEndpoint?: string;
507
556
  /**
508
- * Indicates whether or not to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address.
557
+ * Indicates whether to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address.
509
558
  */
510
559
  bruteForceProtection?: boolean;
511
560
  /**
512
- * OIDC provider client ID.
561
+ * The strategy's client ID.
513
562
  */
514
563
  clientId?: string;
515
564
  /**
516
- * OIDC provider client secret.
565
+ * The strategy's client secret.
517
566
  */
518
567
  clientSecret?: string;
519
568
  /**
520
- * String.
569
+ * Salesforce community base URL.
521
570
  */
522
571
  communityBaseUrl?: string;
523
572
  /**
524
573
  * A case-sensitive map of key value pairs used as configuration variables for the `customScript`.
525
574
  */
526
575
  configuration?: {
527
- [key: string]: string;
576
+ [key: string]: any;
528
577
  };
529
578
  /**
530
- * Custom database action scripts. For more information, read [Custom Database Action Script Templates](https://auth0.com/docs/connections/database/custom-db/templates).
579
+ * A map of scripts used to integrate with a custom database.
531
580
  */
532
581
  customScripts?: {
533
582
  [key: string]: string;
534
583
  };
535
584
  /**
536
- * (Boolean) When enabled additional debugging information will be generated.
585
+ * When enabled, additional debug information will be generated.
537
586
  */
538
587
  debug?: boolean;
539
588
  /**
540
- * Sign Request Algorithm Digest
589
+ * Sign Request Algorithm Digest.
541
590
  */
542
591
  digestAlgorithm?: string;
592
+ /**
593
+ * Indicates whether to disable the cache or not.
594
+ */
543
595
  disableCache?: boolean;
544
596
  /**
545
- * (Boolean) Disables or enables user sign out.
597
+ * When enabled, will disable sign out.
546
598
  */
547
599
  disableSignOut?: boolean;
548
600
  /**
549
- * Boolean. Indicates whether or not to allow user sign-ups to your application.
601
+ * Indicates whether to allow user sign-ups to your application.
550
602
  */
551
603
  disableSignup?: boolean;
552
604
  /**
553
- * OpenID discovery URL. E.g. `https://auth.example.com/.well-known/openid-configuration`.
605
+ * OpenID discovery URL, e.g. `https://auth.example.com/.well-known/openid-configuration`.
554
606
  */
555
607
  discoveryUrl?: string;
556
608
  /**
557
- * Azure AD domain name.
609
+ * Domain name.
558
610
  */
559
611
  domain?: string;
560
612
  /**
561
- * List of the domains that can be authenticated using the Identity Provider. Only needed for Identifier First authentication flows.
613
+ * List of the domains that can be authenticated using the identity provider. Only needed for Identifier First authentication flows.
562
614
  */
563
615
  domainAliases: string[];
616
+ /**
617
+ * Set to `true` to use a legacy user store.
618
+ */
564
619
  enabledDatabaseCustomization?: boolean;
565
620
  /**
566
621
  * Custom Entity ID for the connection.
567
622
  */
568
623
  entityId?: string;
569
624
  /**
570
- * SAML Attributes mapping. If you're configuring a SAML enterprise connection for a non-standard PingFederate Server, you must update the attribute mappings.
625
+ * If you're configuring a SAML enterprise connection for a non-standard PingFederate Server, you must update the attribute mappings.
571
626
  */
572
627
  fieldsMap?: string;
628
+ /**
629
+ * Specifies whether or not request info should be forwarded to sms gateway.
630
+ */
573
631
  forwardRequestInfo?: boolean;
574
632
  /**
575
- * SMS number for the sender. Used when SMS Source is From.
633
+ * Address to use as the sender.
576
634
  */
577
635
  from?: string;
636
+ /**
637
+ * Defines the parameters used to generate the auth token for the custom gateway.
638
+ */
578
639
  gatewayAuthentication?: outputs.ConnectionOptionsGatewayAuthentication;
640
+ /**
641
+ * Defines a custom sms gateway to use instead of Twilio.
642
+ */
579
643
  gatewayUrl?: string;
644
+ /**
645
+ * Icon URL.
646
+ */
580
647
  iconUrl?: string;
648
+ /**
649
+ * Azure AD Identity API. Available options are: `microsoft-identity-platform-v2.0` or `azure-active-directory-v1.0`.
650
+ */
581
651
  identityApi?: string;
582
652
  /**
583
- * Configuration Options for IDP Initiated Authentication. This is an object with the properties: `clientId`, `clientProtocol`, and `clientAuthorizeQuery`
653
+ * Configuration options for IDP Initiated Authentication. This is an object with the properties: `clientId`, `clientProtocol`, and `clientAuthorizeQuery`.
584
654
  */
585
655
  idpInitiated?: outputs.ConnectionOptionsIdpInitiated;
586
656
  /**
587
- * Indicates whether or not you have a legacy user store and want to gradually migrate those users to the Auth0 user store. [Learn more](https://auth0.com/docs/users/guides/configure-automatic-migration).
657
+ * Indicates whether you have a legacy user store and want to gradually migrate those users to the Auth0 user store.
588
658
  */
589
659
  importMode?: boolean;
660
+ /**
661
+ * A list of IPs.
662
+ */
590
663
  ips: string[];
591
664
  /**
592
- * Issuer URL. E.g. `https://auth.example.com`
665
+ * Issuer URL, e.g. `https://auth.example.com`.
593
666
  */
594
667
  issuer?: string;
668
+ /**
669
+ * JWKS URI.
670
+ */
595
671
  jwksUri?: string;
596
672
  /**
597
- * Key ID.
673
+ * Apple Key ID.
598
674
  */
599
675
  keyId?: string;
600
676
  /**
@@ -606,39 +682,39 @@ export interface ConnectionOptions {
606
682
  */
607
683
  messagingServiceSid?: string;
608
684
  /**
609
- * URL of the SAML metadata document.
685
+ * The URL of the SAML metadata document.
610
686
  */
611
687
  metadataUrl?: string;
612
688
  /**
613
- * XML content for the SAML metadata document.
689
+ * The XML content for the SAML metadata document.
614
690
  */
615
691
  metadataXml?: string;
616
692
  /**
617
- * Configuration settings Options for multifactor authentication. For details, see MFA Options.
693
+ * Configuration options for multifactor authentication.
618
694
  */
619
695
  mfa: outputs.ConnectionOptionsMfa;
620
696
  /**
621
- * Name of the connection.
697
+ * The public name of the email or SMS Connection. In most cases this is the same name as the connection name.
622
698
  */
623
699
  name?: string;
624
700
  /**
625
- * If there are user fields that should not be stored in Auth0 databases due to privacy reasons, you can add them to the denylist. See [here](https://auth0.com/docs/security/denylist-user-attributes) for more info.
701
+ * If there are user fields that should not be stored in Auth0 databases due to privacy reasons, you can add them to the DenyList here.
626
702
  */
627
703
  nonPersistentAttrs: string[];
628
704
  /**
629
- * Configuration settings for password complexity. For details, see Password Complexity Options.
705
+ * Configuration settings for password complexity.
630
706
  */
631
707
  passwordComplexityOptions: outputs.ConnectionOptionsPasswordComplexityOptions;
632
708
  /**
633
- * Configuration settings for the password dictionary check, which does not allow passwords that are part of the password dictionary. For details, see Password Dictionary.
709
+ * Configuration settings for the password dictionary check, which does not allow passwords that are part of the password dictionary.
634
710
  */
635
711
  passwordDictionary: outputs.ConnectionOptionsPasswordDictionary;
636
712
  /**
637
- * Configuration settings for the password history that is maintained for each user to prevent the reuse of passwords. For details, see Password History.
713
+ * Configuration settings for the password history that is maintained for each user to prevent the reuse of passwords.
638
714
  */
639
715
  passwordHistories: outputs.ConnectionOptionsPasswordHistory[];
640
716
  /**
641
- * Configuration settings for the password personal info check, which does not allow passwords that contain any part of the user's personal data, including user's name, username, nickname, user_metadata.name, user_metadata.first, user_metadata.last, user's email, or first part of the user's email. For details, see Password No Personal Info.
717
+ * Configuration settings for the password personal info check, which does not allow passwords that contain any part of the user's personal data, including user's `name`, `username`, `nickname`, `user_metadata.name`, `user_metadata.first`, `user_metadata.last`, user's `email`, or first part of the user's `email`.
642
718
  */
643
719
  passwordNoPersonalInfo: outputs.ConnectionOptionsPasswordNoPersonalInfo;
644
720
  /**
@@ -646,35 +722,41 @@ export interface ConnectionOptions {
646
722
  */
647
723
  passwordPolicy: string;
648
724
  /**
649
- * (Boolean) Enables proof key for code exchange (PKCE) functionality for OAuth2 connections.
725
+ * Enables Proof Key for Code Exchange (PKCE) functionality for OAuth2 connections.
650
726
  */
651
727
  pkceEnabled?: boolean;
652
728
  /**
653
- * The SAML Response Binding - how the SAML token is received by Auth0 from IdP. Two possible values are `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect` (default) and `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST`
729
+ * The SAML Response Binding: how the SAML token is received by Auth0 from the IdP.
654
730
  */
655
731
  protocolBinding?: string;
732
+ /**
733
+ * Defines the custom `smsGateway` provider.
734
+ */
656
735
  provider?: string;
657
736
  /**
658
- * Template that formats the SAML request
737
+ * Template that formats the SAML request.
659
738
  */
660
739
  requestTemplate?: string;
661
740
  /**
662
- * Indicates whether or not the user is required to provide a username in addition to an email address.
741
+ * Indicates whether the user is required to provide a username in addition to an email address.
663
742
  */
664
743
  requiresUsername?: boolean;
665
744
  /**
666
- * Scopes required by the connection. The value must be a list, for example `["openid", "profile", "email"]`.
745
+ * Permissions to grant to the connection. Within the Auth0 dashboard these appear under the "Attributes" and "Extended Attributes" sections. Some examples: `basicProfile`, `extProfile`, `extNestedGroups`, etc.
667
746
  */
668
747
  scopes: string[];
748
+ /**
749
+ * A map of scripts used for an OAuth connection. Only accepts a `fetchUserProfile` script.
750
+ */
669
751
  scripts?: {
670
752
  [key: string]: string;
671
753
  };
672
754
  /**
673
- * Determines whether the 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes can be independently updated when using the external IdP. Default is `onEachLogin` and can be set to `onFirstLogin`.
755
+ * Determines whether the 'name', 'given*name', 'family*name', 'nickname', and 'picture' attributes can be independently updated when using an external IdP. Possible values are 'on*each*login' (default value, it configures the connection to automatically update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on*first*login' (configures the connection to only set the root attributes on first login, allowing them to be independently updated thereafter).
674
756
  */
675
757
  setUserRootAttributes: string;
676
758
  /**
677
- * Determines how Auth0 sets the emailVerified field in the user profile. Can either be set to `neverSetEmailsAsVerified` or `alwaysSetEmailsAsVerified`.
759
+ * Choose how Auth0 sets the emailVerified field in the user profile.
678
760
  */
679
761
  shouldTrustEmailVerifiedConnection?: string;
680
762
  /**
@@ -686,19 +768,19 @@ export interface ConnectionOptions {
686
768
  */
687
769
  signOutEndpoint?: string;
688
770
  /**
689
- * (Boolean) When enabled, the SAML authentication request will be signed.
771
+ * When enabled, the SAML authentication request will be signed.
690
772
  */
691
773
  signSamlRequest?: boolean;
692
774
  /**
693
- * Sign Request Algorithm
775
+ * Sign Request Algorithm.
694
776
  */
695
777
  signatureAlgorithm?: string;
696
778
  /**
697
- * The X.509 signing certificate (encoded in PEM or CER) you retrieved from the IdP, Base64-encoded
779
+ * X.509 signing certificate (encoded in PEM or CER) you retrieved from the IdP, Base64-encoded.
698
780
  */
699
781
  signingCert?: string;
700
782
  /**
701
- * . The key used to sign requests in the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively.
783
+ * The key used to sign requests in the connection. Uses the `key` and `cert` properties to provide the private key and certificate respectively.
702
784
  */
703
785
  signingKey?: outputs.ConnectionOptionsSigningKey;
704
786
  /**
@@ -706,25 +788,31 @@ export interface ConnectionOptions {
706
788
  */
707
789
  strategyVersion: number;
708
790
  /**
709
- * String. Subject line of the email. You can include [common variables](https://auth0.com/docs/email/templates#common-variables).
791
+ * Subject line of the email.
710
792
  */
711
793
  subject?: string;
712
794
  /**
713
- * Syntax of the SMS. Options include `markdown` and `liquid`.
795
+ * Syntax of the template body.
714
796
  */
715
797
  syntax?: string;
716
798
  /**
717
- * Team ID.
799
+ * Apple Team ID.
718
800
  */
719
801
  teamId?: string;
720
802
  /**
721
- * Template for the SMS. You can use `@@password@@` as a placeholder for the password value.
803
+ * Body of the template.
722
804
  */
723
805
  template?: string;
806
+ /**
807
+ * Tenant domain name.
808
+ */
724
809
  tenantDomain?: string;
810
+ /**
811
+ * Token endpoint.
812
+ */
725
813
  tokenEndpoint?: string;
726
814
  /**
727
- * Configuration options for one-time passwords. For details, see TOTP.
815
+ * Configuration options for one-time passwords.
728
816
  */
729
817
  totp?: outputs.ConnectionOptionsTotp;
730
818
  /**
@@ -740,25 +828,40 @@ export interface ConnectionOptions {
740
828
  */
741
829
  type?: string;
742
830
  /**
743
- * String (JSON Encoded). You can pass provider-specific parameters to an Identity Provider during authentication. The values can either be static per connection or dynamic per user.
831
+ * You can pass provider-specific parameters to an identity provider during authentication. The values can either be static per connection or dynamic per user.
744
832
  */
745
833
  upstreamParams?: string;
834
+ /**
835
+ * Indicates whether to use cert auth or not.
836
+ */
746
837
  useCertAuth?: boolean;
838
+ /**
839
+ * Indicates whether to use Kerberos or not.
840
+ */
747
841
  useKerberos?: boolean;
842
+ /**
843
+ * Whether to use WS-Fed.
844
+ */
748
845
  useWsfed?: boolean;
749
846
  /**
750
847
  * Attribute in the SAML token that will be mapped to the userId property in Auth0.
751
848
  */
752
849
  userIdAttribute?: string;
850
+ /**
851
+ * User info endpoint.
852
+ */
753
853
  userinfoEndpoint?: string;
754
854
  /**
755
- * Validation of the minimum and maximum values allowed for a user to have as username. For details, see Validation.
855
+ * Validation of the minimum and maximum values allowed for a user to have as username.
756
856
  */
757
857
  validation?: outputs.ConnectionOptionsValidation;
758
858
  /**
759
- * Indicates whether or not to use the common endpoint rather than the default endpoint. Typically enabled if you're using this for a multi-tenant application in Azure AD.
859
+ * Indicates whether to use the common endpoint rather than the default endpoint. Typically enabled if you're using this for a multi-tenant application in Azure AD.
760
860
  */
761
861
  waadCommonEndpoint?: boolean;
862
+ /**
863
+ * Protocol to use.
864
+ */
762
865
  waadProtocol?: string;
763
866
  }
764
867
  export interface ConnectionOptionsGatewayAuthentication {
@@ -766,59 +869,29 @@ export interface ConnectionOptionsGatewayAuthentication {
766
869
  method?: string;
767
870
  secret?: string;
768
871
  secretBase64Encoded?: boolean;
769
- /**
770
- * String. Subject line of the email. You can include [common variables](https://auth0.com/docs/email/templates#common-variables).
771
- */
772
872
  subject?: string;
773
873
  }
774
874
  export interface ConnectionOptionsIdpInitiated {
775
875
  clientAuthorizeQuery?: string;
776
- /**
777
- * Google client ID.
778
- */
779
876
  clientId?: string;
780
877
  clientProtocol?: string;
781
878
  }
782
879
  export interface ConnectionOptionsMfa {
783
- /**
784
- * Indicates whether multifactor authentication is enabled for this connection.
785
- */
786
880
  active?: boolean;
787
- /**
788
- * Indicates whether multifactor authentication enrollment settings will be returned.
789
- */
790
881
  returnEnrollSettings?: boolean;
791
882
  }
792
883
  export interface ConnectionOptionsPasswordComplexityOptions {
793
- /**
794
- * Minimum number of characters allowed in passwords.
795
- */
796
884
  minLength?: number;
797
885
  }
798
886
  export interface ConnectionOptionsPasswordDictionary {
799
- /**
800
- * Customized contents of the password dictionary. By default, the password dictionary contains a list of the [10,000 most common passwords](https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt); your customized content is used in addition to the default password dictionary. Matching is not case-sensitive.
801
- */
802
887
  dictionaries?: string[];
803
- /**
804
- * Indicates whether the password dictionary check is enabled for this connection.
805
- */
806
888
  enable?: boolean;
807
889
  }
808
890
  export interface ConnectionOptionsPasswordHistory {
809
- /**
810
- * Indicates whether password history is enabled for the connection. When enabled, any existing users in this connection will be unaffected; the system will maintain their password history going forward.
811
- */
812
891
  enable?: boolean;
813
- /**
814
- * Indicates the number of passwords to keep in history with a maximum of 24.
815
- */
816
892
  size?: number;
817
893
  }
818
894
  export interface ConnectionOptionsPasswordNoPersonalInfo {
819
- /**
820
- * Indicates whether the password personal info check is enabled for this connection.
821
- */
822
895
  enable?: boolean;
823
896
  }
824
897
  export interface ConnectionOptionsSigningKey {
@@ -826,19 +899,10 @@ export interface ConnectionOptionsSigningKey {
826
899
  key: string;
827
900
  }
828
901
  export interface ConnectionOptionsTotp {
829
- /**
830
- * Integer. Length of the one-time password.
831
- */
832
902
  length?: number;
833
- /**
834
- * Integer. Seconds between allowed generation of new passwords.
835
- */
836
903
  timeStep?: number;
837
904
  }
838
905
  export interface ConnectionOptionsValidation {
839
- /**
840
- * Specifies the `min` and `max` values of username length. `min` and `max` are integers.
841
- */
842
906
  username?: outputs.ConnectionOptionsValidationUsername;
843
907
  }
844
908
  export interface ConnectionOptionsValidationUsername {
@@ -846,47 +910,47 @@ export interface ConnectionOptionsValidationUsername {
846
910
  min?: number;
847
911
  }
848
912
  export interface CustomDomainVerification {
849
- /**
850
- * List(Map). Verification methods for the domain.
851
- */
852
913
  methods: any[];
853
914
  }
854
915
  export interface EmailCredentials {
855
916
  /**
856
- * String, Case-sensitive. AWS Access Key ID. Used only for AWS.
917
+ * AWS Access Key ID. Used only for AWS.
857
918
  */
858
919
  accessKeyId?: string;
859
920
  /**
860
- * String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.
921
+ * API Key for your email service. Will always be encrypted in our database.
861
922
  */
862
923
  apiKey?: string;
863
924
  /**
864
- * String. API User for your email service.
925
+ * API User for your email service.
865
926
  */
866
927
  apiUser?: string;
928
+ /**
929
+ * Domain name.
930
+ */
867
931
  domain?: string;
868
932
  /**
869
- * String. Default region. Used only for AWS, Mailgun, and SparkPost.
933
+ * Default region. Used only for AWS, Mailgun, and SparkPost.
870
934
  */
871
935
  region?: string;
872
936
  /**
873
- * String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
937
+ * AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
874
938
  */
875
939
  secretAccessKey?: string;
876
940
  /**
877
- * String. Hostname or IP address of your SMTP server. Used only for SMTP.
941
+ * Hostname or IP address of your SMTP server. Used only for SMTP.
878
942
  */
879
943
  smtpHost?: string;
880
944
  /**
881
- * String, Case-sensitive. SMTP password. Used only for SMTP.
945
+ * SMTP password. Used only for SMTP.
882
946
  */
883
947
  smtpPass?: string;
884
948
  /**
885
- * Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
949
+ * Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
886
950
  */
887
951
  smtpPort?: number;
888
952
  /**
889
- * String. SMTP username. Used only for SMTP.
953
+ * SMTP username. Used only for SMTP.
890
954
  */
891
955
  smtpUser?: string;
892
956
  }
@@ -982,6 +1046,7 @@ export interface GetClientAddonSamlp {
982
1046
  destination: string;
983
1047
  digestAlgorithm: string;
984
1048
  includeAttributeNameFormat: boolean;
1049
+ issuer: string;
985
1050
  lifetimeInSeconds: number;
986
1051
  logout: {
987
1052
  [key: string]: any;
@@ -1131,6 +1196,7 @@ export interface GetGlobalClientAddonSamlp {
1131
1196
  destination: string;
1132
1197
  digestAlgorithm: string;
1133
1198
  includeAttributeNameFormat: boolean;
1199
+ issuer: string;
1134
1200
  lifetimeInSeconds: number;
1135
1201
  logout: {
1136
1202
  [key: string]: any;
@@ -1243,7 +1309,10 @@ export interface GlobalClientAddons {
1243
1309
  salesforceSandboxApi?: {
1244
1310
  [key: string]: any;
1245
1311
  };
1246
- samlp: outputs.GlobalClientAddonsSamlp;
1312
+ /**
1313
+ * Configuration settings for a SAML add-on.
1314
+ */
1315
+ samlp?: outputs.GlobalClientAddonsSamlp;
1247
1316
  sapApi?: {
1248
1317
  [key: string]: any;
1249
1318
  };
@@ -1262,6 +1331,9 @@ export interface GlobalClientAddons {
1262
1331
  wams?: {
1263
1332
  [key: string]: any;
1264
1333
  };
1334
+ /**
1335
+ * WS-Fed (WIF) addon indicator. Actual configuration is stored in callback and `clientAliases` properties on the client.
1336
+ */
1265
1337
  wsfed?: {
1266
1338
  [key: string]: any;
1267
1339
  };
@@ -1280,6 +1352,7 @@ export interface GlobalClientAddonsSamlp {
1280
1352
  destination?: string;
1281
1353
  digestAlgorithm?: string;
1282
1354
  includeAttributeNameFormat?: boolean;
1355
+ issuer?: string;
1283
1356
  lifetimeInSeconds?: number;
1284
1357
  logout?: {
1285
1358
  [key: string]: any;
@@ -1299,16 +1372,34 @@ export interface GlobalClientAddonsSamlp {
1299
1372
  typedAttributes?: boolean;
1300
1373
  }
1301
1374
  export interface GlobalClientJwtConfiguration {
1375
+ /**
1376
+ * Algorithm used to sign JWTs.
1377
+ */
1302
1378
  alg?: string;
1379
+ /**
1380
+ * Number of seconds during which the JWT will be valid.
1381
+ */
1303
1382
  lifetimeInSeconds: number;
1383
+ /**
1384
+ * Permissions (scopes) included in JWTs.
1385
+ */
1304
1386
  scopes?: {
1305
1387
  [key: string]: string;
1306
1388
  };
1389
+ /**
1390
+ * Indicates whether the client secret is Base64-encoded.
1391
+ */
1307
1392
  secretEncoded: boolean;
1308
1393
  }
1309
1394
  export interface GlobalClientMobile {
1310
- android?: outputs.GlobalClientMobileAndroid;
1311
- ios?: outputs.GlobalClientMobileIos;
1395
+ /**
1396
+ * Configuration settings for Android native apps.
1397
+ */
1398
+ android: outputs.GlobalClientMobileAndroid;
1399
+ /**
1400
+ * Configuration settings for i0S native apps.
1401
+ */
1402
+ ios: outputs.GlobalClientMobileIos;
1312
1403
  }
1313
1404
  export interface GlobalClientMobileAndroid {
1314
1405
  appPackageName?: string;
@@ -1319,8 +1410,8 @@ export interface GlobalClientMobileIos {
1319
1410
  teamId?: string;
1320
1411
  }
1321
1412
  export interface GlobalClientNativeSocialLogin {
1322
- apple?: outputs.GlobalClientNativeSocialLoginApple;
1323
- facebook?: outputs.GlobalClientNativeSocialLoginFacebook;
1413
+ apple: outputs.GlobalClientNativeSocialLoginApple;
1414
+ facebook: outputs.GlobalClientNativeSocialLoginFacebook;
1324
1415
  }
1325
1416
  export interface GlobalClientNativeSocialLoginApple {
1326
1417
  enabled?: boolean;
@@ -1329,171 +1420,156 @@ export interface GlobalClientNativeSocialLoginFacebook {
1329
1420
  enabled?: boolean;
1330
1421
  }
1331
1422
  export interface GlobalClientRefreshToken {
1423
+ /**
1424
+ * Options include `expiring`, `non-expiring`. Whether a refresh token will expire based on an absolute lifetime, after which the token can no longer be used. If rotation is `rotating`, this must be set to `expiring`.
1425
+ */
1332
1426
  expirationType: string;
1427
+ /**
1428
+ * The time in seconds after which inactive refresh tokens will expire.
1429
+ */
1333
1430
  idleTokenLifetime: number;
1431
+ /**
1432
+ * Whether inactive refresh tokens should remain valid indefinitely.
1433
+ */
1334
1434
  infiniteIdleTokenLifetime: boolean;
1435
+ /**
1436
+ * Whether refresh tokens should remain valid indefinitely. If false, `tokenLifetime` should also be set.
1437
+ */
1335
1438
  infiniteTokenLifetime: boolean;
1439
+ /**
1440
+ * The amount of time in seconds in which a refresh token may be reused without triggering reuse detection.
1441
+ */
1336
1442
  leeway: number;
1443
+ /**
1444
+ * Options include `rotating`, `non-rotating`. When `rotating`, exchanging a refresh token will cause a new refresh token to be issued and the existing token will be invalidated. This allows for automatic detection of token reuse if the token is leaked.
1445
+ */
1337
1446
  rotationType: string;
1447
+ /**
1448
+ * The absolute lifetime of a refresh token in seconds.
1449
+ */
1338
1450
  tokenLifetime: number;
1339
1451
  }
1340
1452
  export interface GuardianDuo {
1341
1453
  /**
1342
- * String. Duo API Hostname, see the Duo documentation for more details on Duo setup.
1454
+ * Duo API Hostname, see the Duo documentation for more details on Duo setup.
1343
1455
  */
1344
1456
  hostname: string;
1345
1457
  /**
1346
- * String. Duo client ID, see the Duo documentation for more details on Duo setup.
1458
+ * Duo client ID, see the Duo documentation for more details on Duo setup.
1347
1459
  */
1348
1460
  integrationKey: string;
1349
1461
  /**
1350
- * String. Duo client secret, see the Duo documentation for more details on Duo setup.
1462
+ * Duo client secret, see the Duo documentation for more details on Duo setup.
1351
1463
  */
1352
1464
  secretKey: string;
1353
1465
  }
1354
1466
  export interface GuardianPhone {
1355
1467
  /**
1356
- * List(String). Message types to use, array of `sms` and or `voice`. Adding both to array should enable the user to choose.
1468
+ * Message types to use, array of `sms` and/or `voice`. Adding both to the array should enable the user to choose.
1357
1469
  */
1358
1470
  messageTypes: string[];
1359
1471
  /**
1360
- * List(Resource). Options for the various providers. See Options.
1472
+ * Options for the various providers.
1361
1473
  */
1362
1474
  options: outputs.GuardianPhoneOptions;
1363
1475
  /**
1364
- * String, Case-sensitive. Provider to use, one of `auth0`, `twilio` or `phone-message-hook`.
1476
+ * Provider to use, one of `auth0`, `twilio` or `phone-message-hook`.
1365
1477
  */
1366
1478
  provider: string;
1367
1479
  }
1368
1480
  export interface GuardianPhoneOptions {
1369
- /**
1370
- * String.
1371
- */
1372
1481
  authToken?: string;
1373
- /**
1374
- * String. This message will be sent whenever a user enrolls a new device for the first time using MFA. Supports liquid syntax, see [Auth0 docs](https://auth0.com/docs/mfa/customize-sms-or-voice-messages).
1375
- */
1376
1482
  enrollmentMessage?: string;
1377
- /**
1378
- * String.
1379
- */
1380
1483
  from?: string;
1381
- /**
1382
- * String.
1383
- */
1384
1484
  messagingServiceSid?: string;
1385
- /**
1386
- * String.
1387
- */
1388
1485
  sid?: string;
1389
- /**
1390
- * String. This message will be sent whenever a user logs in after the enrollment. Supports liquid syntax, see [Auth0 docs](https://auth0.com/docs/mfa/customize-sms-or-voice-messages).
1391
- */
1392
1486
  verificationMessage?: string;
1393
1487
  }
1394
1488
  export interface GuardianPush {
1489
+ /**
1490
+ * Configuration for Amazon SNS.
1491
+ */
1395
1492
  amazonSns?: outputs.GuardianPushAmazonSns;
1493
+ /**
1494
+ * Configuration for the Guardian Custom App.
1495
+ */
1396
1496
  customApp?: outputs.GuardianPushCustomApp;
1397
1497
  }
1398
1498
  export interface GuardianPushAmazonSns {
1399
- /**
1400
- * String. Your AWS Access Key ID.
1401
- */
1402
1499
  awsAccessKeyId: string;
1403
- /**
1404
- * String. Your AWS application's region.
1405
- */
1406
1500
  awsRegion: string;
1407
- /**
1408
- * String. Your AWS Secret Access Key.
1409
- */
1410
1501
  awsSecretAccessKey: string;
1411
- /**
1412
- * String. The Amazon Resource Name for your Apple Push Notification Service.
1413
- */
1414
1502
  snsApnsPlatformApplicationArn: string;
1415
- /**
1416
- * String. The Amazon Resource Name for your Firebase Cloud Messaging Service.
1417
- */
1418
1503
  snsGcmPlatformApplicationArn: string;
1419
1504
  }
1420
1505
  export interface GuardianPushCustomApp {
1421
- /**
1422
- * String. Custom Application Name.
1423
- */
1424
1506
  appName?: string;
1425
- /**
1426
- * String. Apple App Store URL.
1427
- */
1428
1507
  appleAppLink?: string;
1429
- /**
1430
- * String. Google Store URL.
1431
- */
1432
1508
  googleAppLink?: string;
1433
1509
  }
1434
1510
  export interface GuardianWebauthnPlatform {
1435
1511
  /**
1436
- * Bool. The Relying Party is the domain for which the WebAuthn keys will be issued, set to true if you are customizing the identifier.
1512
+ * The Relying Party is the domain for which the WebAuthn keys will be issued, set to `true` if you are customizing the identifier.
1437
1513
  */
1438
1514
  overrideRelyingParty: boolean;
1439
1515
  /**
1440
- * String. The Relying Party should be a suffix of the custom domain.
1516
+ * The Relying Party should be a suffix of the custom domain.
1441
1517
  */
1442
1518
  relyingPartyIdentifier: string;
1443
1519
  }
1444
1520
  export interface GuardianWebauthnRoaming {
1445
1521
  /**
1446
- * Bool. The Relying Party is the domain for which the WebAuthn keys will be issued, set to true if you are customizing the identifier.
1522
+ * The Relying Party is the domain for which the WebAuthn keys will be issued, set to `true` if you are customizing the identifier.
1447
1523
  */
1448
1524
  overrideRelyingParty: boolean;
1449
1525
  /**
1450
- * String. The Relying Party should be a suffix of the custom domain.
1526
+ * The Relying Party should be a suffix of the custom domain.
1451
1527
  */
1452
1528
  relyingPartyIdentifier: string;
1453
1529
  /**
1454
- * String. User verification, one of `discouraged`, `preferred` or `required`.
1530
+ * User verification, one of `discouraged`, `preferred` or `required`.
1455
1531
  */
1456
1532
  userVerification: string;
1457
1533
  }
1458
1534
  export interface LogStreamSink {
1459
1535
  /**
1460
- * The AWS Account ID
1536
+ * The AWS Account ID.
1461
1537
  */
1462
1538
  awsAccountId?: string;
1463
1539
  /**
1464
- * Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS so this should generally be an output attribute.
1540
+ * Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
1465
1541
  */
1466
1542
  awsPartnerEventSource: string;
1467
1543
  /**
1468
- * The AWS Region (i.e "us-east-2")
1544
+ * The AWS Region, e.g. "us-east-2").
1469
1545
  */
1470
1546
  awsRegion?: string;
1471
1547
  /**
1472
- * Name of the Partner Topic to be used with Azure. Generally should not be specified.
1548
+ * Name of the Partner Topic to be used with Azure. Generally should not be specified.
1473
1549
  */
1474
1550
  azurePartnerTopic: string;
1475
1551
  /**
1476
- * The Azure region code (i.e. "ne")
1552
+ * The Azure region code, e.g. "ne")
1477
1553
  */
1478
1554
  azureRegion?: string;
1479
1555
  /**
1480
- * The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription
1556
+ * The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
1481
1557
  */
1482
1558
  azureResourceGroup?: string;
1483
1559
  /**
1484
- * The unique alphanumeric string that identifies your Azure subscription
1560
+ * The unique alphanumeric string that identifies your Azure subscription.
1485
1561
  */
1486
1562
  azureSubscriptionId?: string;
1487
1563
  /**
1488
- * The Datadog API key
1564
+ * The Datadog API key.
1489
1565
  */
1490
1566
  datadogApiKey?: string;
1491
1567
  /**
1492
- * The Datadog region. Options are ["us", "eu", "us3", "us5"]
1568
+ * The Datadog region. Options are ["us", "eu", "us3", "us5"].
1493
1569
  */
1494
1570
  datadogRegion?: string;
1495
1571
  /**
1496
- * Sent in the HTTP "Authorization" header with each request
1572
+ * Sent in the HTTP "Authorization" header with each request.
1497
1573
  */
1498
1574
  httpAuthorization?: string;
1499
1575
  /**
@@ -1501,221 +1577,210 @@ export interface LogStreamSink {
1501
1577
  */
1502
1578
  httpContentFormat?: string;
1503
1579
  /**
1504
- * The ContentType header to send over HTTP. Common value is "application/json"
1580
+ * The "Content-Type" header to send over HTTP. Common value is "application/json".
1505
1581
  */
1506
1582
  httpContentType?: string;
1507
1583
  /**
1508
- * Additional HTTP headers to be included as part of the HTTP request
1584
+ * Additional HTTP headers to be included as part of the HTTP request.
1509
1585
  */
1510
1586
  httpCustomHeaders?: {
1511
1587
  [key: string]: string;
1512
1588
  }[];
1513
1589
  /**
1514
- * The HTTP endpoint to send streaming logs
1590
+ * The HTTP endpoint to send streaming logs.
1515
1591
  */
1516
1592
  httpEndpoint?: string;
1517
1593
  /**
1518
- * The Splunk domain name
1594
+ * The Splunk domain name.
1519
1595
  */
1520
1596
  splunkDomain?: string;
1597
+ /**
1598
+ * The Splunk port.
1599
+ */
1521
1600
  splunkPort?: string;
1522
1601
  /**
1523
- * This toggle should be turned off when using self-signed certificates
1602
+ * This toggle should be turned off when using self-signed certificates.
1524
1603
  */
1525
1604
  splunkSecure?: boolean;
1526
1605
  /**
1527
- * The Splunk access token
1606
+ * The Splunk access token.
1528
1607
  */
1529
1608
  splunkToken?: string;
1530
1609
  /**
1531
- * Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0
1610
+ * Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
1532
1611
  */
1533
1612
  sumoSourceAddress?: string;
1534
1613
  }
1535
1614
  export interface OrganizationBranding {
1536
1615
  /**
1537
- * Color scheme used to customize the login pages
1616
+ * Color scheme used to customize the login pages.
1538
1617
  */
1539
1618
  colors?: {
1540
1619
  [key: string]: string;
1541
1620
  };
1542
1621
  /**
1543
- * URL of logo to display on login page
1622
+ * URL of logo to display on login page.
1544
1623
  */
1545
1624
  logoUrl?: string;
1546
1625
  }
1547
- export interface OrganizationConnection {
1548
- /**
1549
- * When true, all users that log in
1550
- * with this connection will be automatically granted membership in the
1551
- * organization. When false, users must be granted membership in the organization
1552
- * before logging in with this connection.
1553
- */
1554
- assignMembershipOnLogin?: boolean;
1555
- /**
1556
- * The connection ID of the connection to add to the
1557
- * organization
1558
- */
1559
- connectionId: string;
1560
- }
1561
1626
  export interface ResourceServerScope {
1562
1627
  /**
1563
- * String. Description of the permission (scope).
1628
+ * Description of the permission (scope).
1564
1629
  */
1565
1630
  description?: string;
1566
1631
  /**
1567
- * String. Name of the permission (scope). Examples include `read:appointments` or `delete:appointments`.
1632
+ * Name of the permission (scope). Examples include `read:appointments` or `delete:appointments`.
1568
1633
  */
1569
1634
  value: string;
1570
1635
  }
1571
1636
  export interface RolePermission {
1572
1637
  /**
1573
- * String. Name of the permission (scope).
1638
+ * Name of the permission (scope).
1574
1639
  */
1575
1640
  name: string;
1576
1641
  /**
1577
- * String. Unique identifier for the resource server.
1642
+ * Unique identifier for the resource server.
1578
1643
  */
1579
1644
  resourceServerIdentifier: string;
1580
1645
  }
1581
1646
  export interface TenantChangePassword {
1582
1647
  /**
1583
- * Boolean. Indicates whether to use the custom change password page.
1648
+ * Indicates whether to use the custom change password page.
1584
1649
  */
1585
1650
  enabled: boolean;
1586
1651
  /**
1587
- * String, HTML format with supported Liquid syntax. Customized content of the change password page.
1652
+ * HTML format with supported Liquid syntax. Customized content of the change password page.
1588
1653
  */
1589
1654
  html: string;
1590
1655
  }
1591
1656
  export interface TenantErrorPage {
1592
1657
  /**
1593
- * String, HTML format with supported Liquid syntax. Customized content of the error page.
1658
+ * HTML format with supported Liquid syntax. Customized content of the error page.
1594
1659
  */
1595
1660
  html: string;
1596
1661
  /**
1597
- * Boolean. Indicates whether to show the link to logs as part of the default error page.
1662
+ * Indicates whether to show the link to logs as part of the default error page.
1598
1663
  */
1599
1664
  showLogLink: boolean;
1600
1665
  /**
1601
- * String. URL to redirect to when an error occurs rather than showing the default error page.
1666
+ * URL to redirect to when an error occurs rather than showing the default error page.
1602
1667
  */
1603
1668
  url: string;
1604
1669
  }
1605
1670
  export interface TenantFlags {
1606
1671
  /**
1607
- * Boolean. Whether the legacy delegation endpoint will be enabled for your account (true) or not available (false).
1672
+ * Whether the legacy delegation endpoint will be enabled for your account (true) or not available (false).
1608
1673
  */
1609
1674
  allowLegacyDelegationGrantTypes: boolean;
1610
1675
  /**
1611
- * Boolean. Whether the legacy `auth/ro` endpoint (used with resource owner password and passwordless features) will be enabled for your account (true) or not available (false).
1676
+ * Whether the legacy `auth/ro` endpoint (used with resource owner password and passwordless features) will be enabled for your account (true) or not available (false).
1612
1677
  */
1613
1678
  allowLegacyRoGrantTypes: boolean;
1614
1679
  /**
1615
- * Boolean. If enabled, customers can use Tokeninfo Endpoint, otherwise they can not use it.
1680
+ * If enabled, customers can use Tokeninfo Endpoint, otherwise they can not use it.
1616
1681
  */
1617
1682
  allowLegacyTokeninfoEndpoint: boolean;
1618
1683
  /**
1619
- * Boolean. Enables new insights activity page view.
1684
+ * Enables new insights activity page view.
1620
1685
  */
1621
1686
  dashboardInsightsView: boolean;
1622
1687
  /**
1623
- * Boolean. Enables beta access to log streaming changes.
1688
+ * Enables beta access to log streaming changes.
1624
1689
  */
1625
1690
  dashboardLogStreamsNext: boolean;
1626
1691
  /**
1627
- * Boolean. Indicated whether classic Universal Login prompts include additional security headers to prevent clickjacking.
1692
+ * Indicates whether classic Universal Login prompts include additional security headers to prevent clickjacking.
1628
1693
  */
1629
1694
  disableClickjackProtectionHeaders: boolean;
1630
1695
  /**
1631
- * Boolean. Disables SAML fields map fix for bad mappings with repeated attributes.
1696
+ * Disables SAML fields map fix for bad mappings with repeated attributes.
1632
1697
  */
1633
1698
  disableFieldsMapFix: boolean;
1634
1699
  /**
1635
- * Boolean. If true, SMS phone numbers will not be obfuscated in Management API GET calls.
1700
+ * If true, SMS phone numbers will not be obfuscated in Management API GET calls.
1636
1701
  */
1637
1702
  disableManagementApiSmsObfuscation: boolean;
1638
1703
  /**
1639
- * Boolean. If enabled, users will be presented with an email verification prompt during their first login when using Azure AD or ADFS connections.
1704
+ * If enabled, users will be presented with an email verification prompt during their first login when using Azure AD or ADFS connections.
1640
1705
  */
1641
1706
  enableAdfsWaadEmailVerification: boolean;
1642
1707
  /**
1643
- * Boolean. Indicates whether the APIs section is enabled for the tenant.
1708
+ * Indicates whether the APIs section is enabled for the tenant.
1644
1709
  */
1645
1710
  enableApisSection: boolean;
1646
1711
  /**
1647
- * Boolean. Indicates whether all current connections should be enabled when a new client is created.
1712
+ * Indicates whether all current connections should be enabled when a new client is created.
1648
1713
  */
1649
1714
  enableClientConnections: boolean;
1650
1715
  /**
1651
- * Boolean. Indicates whether the tenant allows custom domains in emails.
1716
+ * Indicates whether the tenant allows custom domains in emails.
1652
1717
  */
1653
1718
  enableCustomDomainInEmails: boolean;
1654
1719
  /**
1655
- * Boolean. Indicates whether the tenant allows dynamic client registration.
1720
+ * Indicates whether the tenant allows dynamic client registration.
1656
1721
  */
1657
1722
  enableDynamicClientRegistration: boolean;
1658
1723
  /**
1659
- * Boolean. Whether ID tokens can be used to authorize some types of requests to API v2 (true) not not (false).
1724
+ * Whether ID tokens can be used to authorize some types of requests to API v2 (true) or not (false).
1660
1725
  */
1661
1726
  enableIdtokenApi2: boolean;
1662
1727
  /**
1663
- * Boolean. Indicates whether to use the older v2 legacy logs search.
1728
+ * Indicates whether to use the older v2 legacy logs search.
1664
1729
  */
1665
1730
  enableLegacyLogsSearchV2: boolean;
1666
1731
  /**
1667
- * Boolean. Whether ID tokens and the userinfo endpoint includes a complete user profile (true) or only OpenID Connect claims (false).
1732
+ * Whether ID tokens and the userinfo endpoint includes a complete user profile (true) or only OpenID Connect claims (false).
1668
1733
  */
1669
1734
  enableLegacyProfile: boolean;
1670
1735
  /**
1671
- * Boolean. Indicates whether advanced API Authorization scenarios are enabled.
1736
+ * Indicates whether advanced API Authorization scenarios are enabled.
1672
1737
  */
1673
1738
  enablePipeline2: boolean;
1674
1739
  /**
1675
- * Boolean. Indicates whether the public sign up process shows a userExists error if the user already exists.
1740
+ * Indicates whether the public sign up process shows a `userExists` error if the user already exists.
1676
1741
  */
1677
1742
  enablePublicSignupUserExistsError: boolean;
1678
1743
  /**
1679
- * Boolean. Do not Publish Enterprise Connections Information with IdP domains on the lock configuration file.
1744
+ * Do not Publish Enterprise Connections Information with IdP domains on the lock configuration file.
1680
1745
  */
1681
1746
  noDiscloseEnterpriseConnections: boolean;
1682
1747
  /**
1683
- * Boolean. Delete underlying grant when a Refresh Token is revoked via the Authentication API.
1748
+ * Delete underlying grant when a refresh token is revoked via the Authentication API.
1684
1749
  */
1685
1750
  revokeRefreshTokenGrant: boolean;
1686
1751
  /**
1687
- * Boolean. Indicates whether the tenant uses universal login.
1752
+ * Indicates whether the tenant uses Universal Login.
1688
1753
  */
1689
1754
  universalLogin: boolean;
1755
+ /**
1756
+ * Indicates whether to use scope descriptions for consent.
1757
+ */
1690
1758
  useScopeDescriptionsForConsent: boolean;
1691
1759
  }
1692
1760
  export interface TenantGuardianMfaPage {
1693
1761
  /**
1694
- * Boolean. Indicates whether to use the custom Guardian page.
1762
+ * Indicates whether to use the custom Guardian page.
1695
1763
  */
1696
1764
  enabled: boolean;
1697
1765
  /**
1698
- * String, HTML format with supported Liquid syntax. Customized content of the Guardian page.
1766
+ * HTML format with supported Liquid syntax. Customized content of the Guardian page.
1699
1767
  */
1700
1768
  html: string;
1701
1769
  }
1702
1770
  export interface TenantSessionCookie {
1771
+ /**
1772
+ * Behavior of tenant session cookie. Accepts either "persistent" or "non-persistent".
1773
+ */
1703
1774
  mode?: string;
1704
1775
  }
1705
1776
  export interface TenantUniversalLogin {
1706
1777
  /**
1707
- * List(Resource). Configuration settings for Universal Login colors. See Universal Login - Colors.
1778
+ * Configuration settings for Universal Login colors.
1708
1779
  */
1709
1780
  colors?: outputs.TenantUniversalLoginColors;
1710
1781
  }
1711
1782
  export interface TenantUniversalLoginColors {
1712
- /**
1713
- * String, Hexadecimal. Background color of login pages.
1714
- */
1715
1783
  pageBackground: string;
1716
- /**
1717
- * String, Hexadecimal. Primary button background color.
1718
- */
1719
1784
  primary: string;
1720
1785
  }
1721
1786
  export interface TriggerBindingAction {
@@ -1724,7 +1789,7 @@ export interface TriggerBindingAction {
1724
1789
  */
1725
1790
  displayName: string;
1726
1791
  /**
1727
- * Trigger ID.
1792
+ * Action ID.
1728
1793
  */
1729
1794
  id: string;
1730
1795
  }