@descope/pulumi-descope 0.0.3 → 0.0.4

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/types/input.d.ts CHANGED
@@ -1,41 +1,89 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "../types/input";
3
3
  export interface ProjectApplications {
4
+ /**
5
+ * Applications using OpenID Connect (OIDC) for authentication.
6
+ */
4
7
  oidcApplications?: pulumi.Input<pulumi.Input<inputs.ProjectApplicationsOidcApplication>[]>;
8
+ /**
9
+ * Applications using SAML for authentication.
10
+ */
5
11
  samlApplications?: pulumi.Input<pulumi.Input<inputs.ProjectApplicationsSamlApplication>[]>;
6
12
  }
7
13
  export interface ProjectApplicationsOidcApplication {
14
+ /**
15
+ * Claims associated with JWT tokens, typically used for user information.
16
+ */
8
17
  claims?: pulumi.Input<pulumi.Input<string>[]>;
18
+ /**
19
+ * A brief description of the application.
20
+ */
9
21
  description?: pulumi.Input<string>;
22
+ /**
23
+ * Indicates whether the resource or functionality is disabled.
24
+ */
10
25
  disabled?: pulumi.Input<boolean>;
11
26
  /**
12
- * The ID of this resource.
27
+ * An optional identifier for the application.
13
28
  */
14
29
  id?: pulumi.Input<string>;
30
+ /**
31
+ * The URL of the custom login page for the application.
32
+ */
15
33
  loginPageUrl?: pulumi.Input<string>;
34
+ /**
35
+ * The URL of the logo associated with the application.
36
+ */
16
37
  logo?: pulumi.Input<string>;
38
+ /**
39
+ * The name of the application.
40
+ */
17
41
  name: pulumi.Input<string>;
18
42
  }
19
43
  export interface ProjectApplicationsSamlApplication {
20
44
  acsAllowedCallbackUrls?: pulumi.Input<pulumi.Input<string>[]>;
45
+ /**
46
+ * Map user attributes from the third party identity provider to custom attributes in Descope.
47
+ */
21
48
  attributeMappings?: pulumi.Input<pulumi.Input<inputs.ProjectApplicationsSamlApplicationAttributeMapping>[]>;
22
49
  defaultRelayState?: pulumi.Input<string>;
50
+ /**
51
+ * A brief description of the application.
52
+ */
23
53
  description?: pulumi.Input<string>;
54
+ /**
55
+ * Indicates whether the application is disabled.
56
+ */
24
57
  disabled?: pulumi.Input<boolean>;
25
58
  dynamicConfiguration?: pulumi.Input<inputs.ProjectApplicationsSamlApplicationDynamicConfiguration>;
26
59
  /**
27
- * The ID of this resource.
60
+ * An optional identifier for the application.
28
61
  */
29
62
  id?: pulumi.Input<string>;
63
+ /**
64
+ * The URL of the custom login page for the application.
65
+ */
30
66
  loginPageUrl?: pulumi.Input<string>;
67
+ /**
68
+ * The URL of the logo associated with the application.
69
+ */
31
70
  logo?: pulumi.Input<string>;
32
71
  manualConfiguration?: pulumi.Input<inputs.ProjectApplicationsSamlApplicationManualConfiguration>;
72
+ /**
73
+ * The name of the application.
74
+ */
33
75
  name: pulumi.Input<string>;
34
76
  subjectNameIdFormat?: pulumi.Input<string>;
35
77
  subjectNameIdType?: pulumi.Input<string>;
36
78
  }
37
79
  export interface ProjectApplicationsSamlApplicationAttributeMapping {
80
+ /**
81
+ * The name of the user attribute in the third party identity provider.
82
+ */
38
83
  name: pulumi.Input<string>;
84
+ /**
85
+ * The name of the user custom attribute in Descope.
86
+ */
39
87
  value: pulumi.Input<string>;
40
88
  }
41
89
  export interface ProjectApplicationsSamlApplicationDynamicConfiguration {
@@ -47,45 +95,114 @@ export interface ProjectApplicationsSamlApplicationManualConfiguration {
47
95
  entityId: pulumi.Input<string>;
48
96
  }
49
97
  export interface ProjectAttributes {
98
+ /**
99
+ * Custom attributes to store additional details about your tenants.
100
+ */
50
101
  tenants?: pulumi.Input<pulumi.Input<inputs.ProjectAttributesTenant>[]>;
102
+ /**
103
+ * Custom attributes to store additional details about your users.
104
+ */
51
105
  users?: pulumi.Input<pulumi.Input<inputs.ProjectAttributesUser>[]>;
52
106
  }
53
107
  export interface ProjectAttributesTenant {
108
+ /**
109
+ * The name of the tenant attribute.
110
+ */
54
111
  name: pulumi.Input<string>;
112
+ /**
113
+ * A list of strings to define the set of options for select attributes.
114
+ */
55
115
  selectOptions?: pulumi.Input<pulumi.Input<string>[]>;
116
+ /**
117
+ * The type of the tenant attribute. Valid valus are `string`, `number`, `boolean`, `date`, `singleselect`, and `multiselect`.
118
+ */
56
119
  type: pulumi.Input<string>;
57
120
  }
58
121
  export interface ProjectAttributesUser {
122
+ /**
123
+ * The name of the user attribute.
124
+ */
59
125
  name: pulumi.Input<string>;
126
+ /**
127
+ * A list of strings to define the set of options for select attributes.
128
+ */
60
129
  selectOptions?: pulumi.Input<pulumi.Input<string>[]>;
130
+ /**
131
+ * The type of the user attribute. Valid valus are `string`, `number`, `boolean`, `date`, `singleselect`, and `multiselect`.
132
+ */
61
133
  type: pulumi.Input<string>;
134
+ /**
135
+ * When provided, viewing and editing the attribute values in widgets will be restricted to users with the specified permissions.
136
+ */
62
137
  widgetAuthorization?: pulumi.Input<inputs.ProjectAttributesUserWidgetAuthorization>;
63
138
  }
64
139
  export interface ProjectAttributesUserWidgetAuthorization {
140
+ /**
141
+ * Editing the attribute value in widgets will be restricted to users with the specified permissions.
142
+ */
65
143
  editPermissions?: pulumi.Input<pulumi.Input<string>[]>;
144
+ /**
145
+ * Viewing the attribute value in widgets will be restricted to users with the specified permissions.
146
+ */
66
147
  viewPermissions?: pulumi.Input<pulumi.Input<string>[]>;
67
148
  }
68
149
  export interface ProjectAuthentication {
150
+ /**
151
+ * Make the authentication experience smoother for the user by generating their initial token in a way that does not require the end user to initiate the process, requiring only verification.
152
+ */
69
153
  embeddedLink?: pulumi.Input<inputs.ProjectAuthenticationEmbeddedLink>;
154
+ /**
155
+ * An enhanced and more secure version of Magic Link, enabling users to start the authentication process on one device and execute the verification on another.
156
+ */
70
157
  enchantedLink?: pulumi.Input<inputs.ProjectAuthenticationEnchantedLink>;
158
+ /**
159
+ * An authentication method where a user receives a unique link via email to log in.
160
+ */
71
161
  magicLink?: pulumi.Input<inputs.ProjectAuthenticationMagicLink>;
162
+ /**
163
+ * Authentication using Open Authorization, which allows users to authenticate with various external services.
164
+ */
72
165
  oauth?: pulumi.Input<inputs.ProjectAuthenticationOauth>;
166
+ /**
167
+ * A dynamically generated set of numbers, granting the user one-time access.
168
+ */
73
169
  otp?: pulumi.Input<inputs.ProjectAuthenticationOtp>;
170
+ /**
171
+ * Device-based passwordless authentication, using fingerprint, face scan, and more.
172
+ */
173
+ passkeys?: pulumi.Input<inputs.ProjectAuthenticationPasskeys>;
174
+ /**
175
+ * The classic username and password combination used for authentication.
176
+ */
74
177
  password?: pulumi.Input<inputs.ProjectAuthenticationPassword>;
178
+ /**
179
+ * Single Sign-On (SSO) authentication method that enables users to access multiple applications with a single set of credentials.
180
+ */
75
181
  sso?: pulumi.Input<inputs.ProjectAuthenticationSso>;
182
+ /**
183
+ * A one-time code generated for the user using a shared secret and time.
184
+ */
76
185
  totp?: pulumi.Input<inputs.ProjectAuthenticationTotp>;
77
- webauthn?: pulumi.Input<inputs.ProjectAuthenticationWebauthn>;
78
186
  }
79
187
  export interface ProjectAuthenticationEmbeddedLink {
80
188
  enabled?: pulumi.Input<boolean>;
189
+ /**
190
+ * The amount of time that the embedded link will be valid for.
191
+ */
81
192
  expirationTime?: pulumi.Input<number>;
82
193
  expirationTimeUnit?: pulumi.Input<string>;
83
194
  }
84
195
  export interface ProjectAuthenticationEnchantedLink {
196
+ /**
197
+ * Settings related to sending emails as part of the enchanted link authentication.
198
+ */
85
199
  emailService?: pulumi.Input<inputs.ProjectAuthenticationEnchantedLinkEmailService>;
86
200
  enabled?: pulumi.Input<boolean>;
87
201
  expirationTime?: pulumi.Input<number>;
88
202
  expirationTimeUnit?: pulumi.Input<string>;
203
+ /**
204
+ * The URL to redirect users to after they log in using the enchanted link.
205
+ */
89
206
  redirectUrl?: pulumi.Input<string>;
90
207
  }
91
208
  export interface ProjectAuthenticationEnchantedLinkEmailService {
@@ -102,11 +219,20 @@ export interface ProjectAuthenticationEnchantedLinkEmailServiceTemplate {
102
219
  usePlainTextBody?: pulumi.Input<boolean>;
103
220
  }
104
221
  export interface ProjectAuthenticationMagicLink {
222
+ /**
223
+ * Settings related to sending emails as part of the magic link authentication.
224
+ */
105
225
  emailService?: pulumi.Input<inputs.ProjectAuthenticationMagicLinkEmailService>;
106
226
  enabled?: pulumi.Input<boolean>;
107
227
  expirationTime?: pulumi.Input<number>;
108
228
  expirationTimeUnit?: pulumi.Input<string>;
229
+ /**
230
+ * The URL to redirect users to after they log in using the magic link.
231
+ */
109
232
  redirectUrl?: pulumi.Input<string>;
233
+ /**
234
+ * Settings related to sending SMS messages as part of the magic link authentication.
235
+ */
110
236
  textService?: pulumi.Input<inputs.ProjectAuthenticationMagicLinkTextService>;
111
237
  }
112
238
  export interface ProjectAuthenticationMagicLinkEmailService {
@@ -133,30 +259,75 @@ export interface ProjectAuthenticationMagicLinkTextServiceTemplate {
133
259
  name: pulumi.Input<string>;
134
260
  }
135
261
  export interface ProjectAuthenticationOauth {
262
+ /**
263
+ * Custom OAuth providers configured for this project.
264
+ */
136
265
  custom?: pulumi.Input<{
137
266
  [key: string]: pulumi.Input<inputs.ProjectAuthenticationOauthCustom>;
138
267
  }>;
139
268
  disabled?: pulumi.Input<boolean>;
269
+ /**
270
+ * Custom configurations for builtin OAuth providers such as Apple, Google, GitHub, Facebook, etc.
271
+ */
140
272
  system?: pulumi.Input<inputs.ProjectAuthenticationOauthSystem>;
141
273
  }
142
274
  export interface ProjectAuthenticationOauthCustom {
275
+ /**
276
+ * The URL that users are redirected to for authorization with the OAuth provider.
277
+ */
143
278
  authorizationEndpoint?: pulumi.Input<string>;
144
279
  claimMapping?: pulumi.Input<{
145
280
  [key: string]: pulumi.Input<string>;
146
281
  }>;
282
+ /**
283
+ * The client ID for the OAuth provider, used to identify the application to the provider.
284
+ */
147
285
  clientId?: pulumi.Input<string>;
286
+ /**
287
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
288
+ */
148
289
  clientSecret?: pulumi.Input<string>;
290
+ /**
291
+ * A brief description of the OAuth provider.
292
+ */
149
293
  description?: pulumi.Input<string>;
150
294
  disabled?: pulumi.Input<boolean>;
295
+ /**
296
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
297
+ */
151
298
  grantType?: pulumi.Input<string>;
152
299
  issuer?: pulumi.Input<string>;
300
+ /**
301
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
302
+ */
153
303
  jwksEndpoint?: pulumi.Input<string>;
304
+ /**
305
+ * The URL of the logo associated with the OAuth provider.
306
+ */
154
307
  logo?: pulumi.Input<string>;
308
+ /**
309
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
310
+ */
155
311
  mergeUserAccounts?: pulumi.Input<boolean>;
312
+ /**
313
+ * Custom prompts or consent screens that users may see during OAuth authentication.
314
+ */
156
315
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
316
+ /**
317
+ * Settings related to token management for the OAuth provider.
318
+ */
157
319
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthCustomProviderTokenManagement>;
320
+ /**
321
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
322
+ */
158
323
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
324
+ /**
325
+ * The URL where the application requests an access token from the OAuth provider.
326
+ */
159
327
  tokenEndpoint?: pulumi.Input<string>;
328
+ /**
329
+ * The URL where the application retrieves user information from the OAuth provider.
330
+ */
160
331
  userInfoEndpoint?: pulumi.Input<string>;
161
332
  }
162
333
  export interface ProjectAuthenticationOauthCustomProviderTokenManagement {
@@ -164,34 +335,100 @@ export interface ProjectAuthenticationOauthCustomProviderTokenManagement {
164
335
  redirectUrl?: pulumi.Input<string>;
165
336
  }
166
337
  export interface ProjectAuthenticationOauthSystem {
338
+ /**
339
+ * Apple's OAuth provider, allowing users to authenticate with their Apple Account.
340
+ */
167
341
  apple?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemApple>;
342
+ /**
343
+ * Discord's OAuth provider, allowing users to authenticate with their Discord account.
344
+ */
168
345
  discord?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemDiscord>;
346
+ /**
347
+ * Facebook's OAuth provider, allowing users to authenticate with their Facebook account.
348
+ */
169
349
  facebook?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemFacebook>;
350
+ /**
351
+ * GitHub's OAuth provider, allowing users to authenticate with their GitHub account.
352
+ */
170
353
  github?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGithub>;
354
+ /**
355
+ * GitLab's OAuth provider, allowing users to authenticate with their GitLab account.
356
+ */
171
357
  gitlab?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGitlab>;
358
+ /**
359
+ * Google's OAuth provider, allowing users to authenticate with their Google account.
360
+ */
172
361
  google?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGoogle>;
362
+ /**
363
+ * LinkedIn's OAuth provider, allowing users to authenticate with their LinkedIn account.
364
+ */
173
365
  linkedin?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemLinkedin>;
366
+ /**
367
+ * Microsoft's OAuth provider, allowing users to authenticate with their Microsoft account.
368
+ */
174
369
  microsoft?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemMicrosoft>;
370
+ /**
371
+ * Slack's OAuth provider, allowing users to authenticate with their Slack account.
372
+ */
175
373
  slack?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemSlack>;
176
374
  }
177
375
  export interface ProjectAuthenticationOauthSystemApple {
376
+ /**
377
+ * The URL that users are redirected to for authorization with the OAuth provider.
378
+ */
178
379
  authorizationEndpoint?: pulumi.Input<string>;
179
380
  claimMapping?: pulumi.Input<{
180
381
  [key: string]: pulumi.Input<string>;
181
382
  }>;
383
+ /**
384
+ * The client ID for the OAuth provider, used to identify the application to the provider.
385
+ */
182
386
  clientId?: pulumi.Input<string>;
387
+ /**
388
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
389
+ */
183
390
  clientSecret?: pulumi.Input<string>;
391
+ /**
392
+ * A brief description of the OAuth provider.
393
+ */
184
394
  description?: pulumi.Input<string>;
185
395
  disabled?: pulumi.Input<boolean>;
396
+ /**
397
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
398
+ */
186
399
  grantType?: pulumi.Input<string>;
187
400
  issuer?: pulumi.Input<string>;
401
+ /**
402
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
403
+ */
188
404
  jwksEndpoint?: pulumi.Input<string>;
405
+ /**
406
+ * The URL of the logo associated with the OAuth provider.
407
+ */
189
408
  logo?: pulumi.Input<string>;
409
+ /**
410
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
411
+ */
190
412
  mergeUserAccounts?: pulumi.Input<boolean>;
413
+ /**
414
+ * Custom prompts or consent screens that users may see during OAuth authentication.
415
+ */
191
416
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
417
+ /**
418
+ * Settings related to token management for the OAuth provider.
419
+ */
192
420
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemAppleProviderTokenManagement>;
421
+ /**
422
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
423
+ */
193
424
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
425
+ /**
426
+ * The URL where the application requests an access token from the OAuth provider.
427
+ */
194
428
  tokenEndpoint?: pulumi.Input<string>;
429
+ /**
430
+ * The URL where the application retrieves user information from the OAuth provider.
431
+ */
195
432
  userInfoEndpoint?: pulumi.Input<string>;
196
433
  }
197
434
  export interface ProjectAuthenticationOauthSystemAppleProviderTokenManagement {
@@ -199,23 +436,62 @@ export interface ProjectAuthenticationOauthSystemAppleProviderTokenManagement {
199
436
  redirectUrl?: pulumi.Input<string>;
200
437
  }
201
438
  export interface ProjectAuthenticationOauthSystemDiscord {
439
+ /**
440
+ * The URL that users are redirected to for authorization with the OAuth provider.
441
+ */
202
442
  authorizationEndpoint?: pulumi.Input<string>;
203
443
  claimMapping?: pulumi.Input<{
204
444
  [key: string]: pulumi.Input<string>;
205
445
  }>;
446
+ /**
447
+ * The client ID for the OAuth provider, used to identify the application to the provider.
448
+ */
206
449
  clientId?: pulumi.Input<string>;
450
+ /**
451
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
452
+ */
207
453
  clientSecret?: pulumi.Input<string>;
454
+ /**
455
+ * A brief description of the OAuth provider.
456
+ */
208
457
  description?: pulumi.Input<string>;
209
458
  disabled?: pulumi.Input<boolean>;
459
+ /**
460
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
461
+ */
210
462
  grantType?: pulumi.Input<string>;
211
463
  issuer?: pulumi.Input<string>;
464
+ /**
465
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
466
+ */
212
467
  jwksEndpoint?: pulumi.Input<string>;
468
+ /**
469
+ * The URL of the logo associated with the OAuth provider.
470
+ */
213
471
  logo?: pulumi.Input<string>;
472
+ /**
473
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
474
+ */
214
475
  mergeUserAccounts?: pulumi.Input<boolean>;
476
+ /**
477
+ * Custom prompts or consent screens that users may see during OAuth authentication.
478
+ */
215
479
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
480
+ /**
481
+ * Settings related to token management for the OAuth provider.
482
+ */
216
483
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemDiscordProviderTokenManagement>;
484
+ /**
485
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
486
+ */
217
487
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
488
+ /**
489
+ * The URL where the application requests an access token from the OAuth provider.
490
+ */
218
491
  tokenEndpoint?: pulumi.Input<string>;
492
+ /**
493
+ * The URL where the application retrieves user information from the OAuth provider.
494
+ */
219
495
  userInfoEndpoint?: pulumi.Input<string>;
220
496
  }
221
497
  export interface ProjectAuthenticationOauthSystemDiscordProviderTokenManagement {
@@ -223,23 +499,62 @@ export interface ProjectAuthenticationOauthSystemDiscordProviderTokenManagement
223
499
  redirectUrl?: pulumi.Input<string>;
224
500
  }
225
501
  export interface ProjectAuthenticationOauthSystemFacebook {
502
+ /**
503
+ * The URL that users are redirected to for authorization with the OAuth provider.
504
+ */
226
505
  authorizationEndpoint?: pulumi.Input<string>;
227
506
  claimMapping?: pulumi.Input<{
228
507
  [key: string]: pulumi.Input<string>;
229
508
  }>;
509
+ /**
510
+ * The client ID for the OAuth provider, used to identify the application to the provider.
511
+ */
230
512
  clientId?: pulumi.Input<string>;
513
+ /**
514
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
515
+ */
231
516
  clientSecret?: pulumi.Input<string>;
517
+ /**
518
+ * A brief description of the OAuth provider.
519
+ */
232
520
  description?: pulumi.Input<string>;
233
521
  disabled?: pulumi.Input<boolean>;
522
+ /**
523
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
524
+ */
234
525
  grantType?: pulumi.Input<string>;
235
526
  issuer?: pulumi.Input<string>;
527
+ /**
528
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
529
+ */
236
530
  jwksEndpoint?: pulumi.Input<string>;
531
+ /**
532
+ * The URL of the logo associated with the OAuth provider.
533
+ */
237
534
  logo?: pulumi.Input<string>;
535
+ /**
536
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
537
+ */
238
538
  mergeUserAccounts?: pulumi.Input<boolean>;
539
+ /**
540
+ * Custom prompts or consent screens that users may see during OAuth authentication.
541
+ */
239
542
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
543
+ /**
544
+ * Settings related to token management for the OAuth provider.
545
+ */
240
546
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemFacebookProviderTokenManagement>;
547
+ /**
548
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
549
+ */
241
550
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
551
+ /**
552
+ * The URL where the application requests an access token from the OAuth provider.
553
+ */
242
554
  tokenEndpoint?: pulumi.Input<string>;
555
+ /**
556
+ * The URL where the application retrieves user information from the OAuth provider.
557
+ */
243
558
  userInfoEndpoint?: pulumi.Input<string>;
244
559
  }
245
560
  export interface ProjectAuthenticationOauthSystemFacebookProviderTokenManagement {
@@ -247,23 +562,62 @@ export interface ProjectAuthenticationOauthSystemFacebookProviderTokenManagement
247
562
  redirectUrl?: pulumi.Input<string>;
248
563
  }
249
564
  export interface ProjectAuthenticationOauthSystemGithub {
565
+ /**
566
+ * The URL that users are redirected to for authorization with the OAuth provider.
567
+ */
250
568
  authorizationEndpoint?: pulumi.Input<string>;
251
569
  claimMapping?: pulumi.Input<{
252
570
  [key: string]: pulumi.Input<string>;
253
571
  }>;
572
+ /**
573
+ * The client ID for the OAuth provider, used to identify the application to the provider.
574
+ */
254
575
  clientId?: pulumi.Input<string>;
576
+ /**
577
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
578
+ */
255
579
  clientSecret?: pulumi.Input<string>;
580
+ /**
581
+ * A brief description of the OAuth provider.
582
+ */
256
583
  description?: pulumi.Input<string>;
257
584
  disabled?: pulumi.Input<boolean>;
585
+ /**
586
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
587
+ */
258
588
  grantType?: pulumi.Input<string>;
259
589
  issuer?: pulumi.Input<string>;
590
+ /**
591
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
592
+ */
260
593
  jwksEndpoint?: pulumi.Input<string>;
594
+ /**
595
+ * The URL of the logo associated with the OAuth provider.
596
+ */
261
597
  logo?: pulumi.Input<string>;
598
+ /**
599
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
600
+ */
262
601
  mergeUserAccounts?: pulumi.Input<boolean>;
602
+ /**
603
+ * Custom prompts or consent screens that users may see during OAuth authentication.
604
+ */
263
605
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
606
+ /**
607
+ * Settings related to token management for the OAuth provider.
608
+ */
264
609
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGithubProviderTokenManagement>;
610
+ /**
611
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
612
+ */
265
613
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
614
+ /**
615
+ * The URL where the application requests an access token from the OAuth provider.
616
+ */
266
617
  tokenEndpoint?: pulumi.Input<string>;
618
+ /**
619
+ * The URL where the application retrieves user information from the OAuth provider.
620
+ */
267
621
  userInfoEndpoint?: pulumi.Input<string>;
268
622
  }
269
623
  export interface ProjectAuthenticationOauthSystemGithubProviderTokenManagement {
@@ -271,23 +625,62 @@ export interface ProjectAuthenticationOauthSystemGithubProviderTokenManagement {
271
625
  redirectUrl?: pulumi.Input<string>;
272
626
  }
273
627
  export interface ProjectAuthenticationOauthSystemGitlab {
628
+ /**
629
+ * The URL that users are redirected to for authorization with the OAuth provider.
630
+ */
274
631
  authorizationEndpoint?: pulumi.Input<string>;
275
632
  claimMapping?: pulumi.Input<{
276
633
  [key: string]: pulumi.Input<string>;
277
634
  }>;
635
+ /**
636
+ * The client ID for the OAuth provider, used to identify the application to the provider.
637
+ */
278
638
  clientId?: pulumi.Input<string>;
639
+ /**
640
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
641
+ */
279
642
  clientSecret?: pulumi.Input<string>;
643
+ /**
644
+ * A brief description of the OAuth provider.
645
+ */
280
646
  description?: pulumi.Input<string>;
281
647
  disabled?: pulumi.Input<boolean>;
648
+ /**
649
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
650
+ */
282
651
  grantType?: pulumi.Input<string>;
283
652
  issuer?: pulumi.Input<string>;
653
+ /**
654
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
655
+ */
284
656
  jwksEndpoint?: pulumi.Input<string>;
657
+ /**
658
+ * The URL of the logo associated with the OAuth provider.
659
+ */
285
660
  logo?: pulumi.Input<string>;
661
+ /**
662
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
663
+ */
286
664
  mergeUserAccounts?: pulumi.Input<boolean>;
665
+ /**
666
+ * Custom prompts or consent screens that users may see during OAuth authentication.
667
+ */
287
668
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
669
+ /**
670
+ * Settings related to token management for the OAuth provider.
671
+ */
288
672
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGitlabProviderTokenManagement>;
673
+ /**
674
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
675
+ */
289
676
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
677
+ /**
678
+ * The URL where the application requests an access token from the OAuth provider.
679
+ */
290
680
  tokenEndpoint?: pulumi.Input<string>;
681
+ /**
682
+ * The URL where the application retrieves user information from the OAuth provider.
683
+ */
291
684
  userInfoEndpoint?: pulumi.Input<string>;
292
685
  }
293
686
  export interface ProjectAuthenticationOauthSystemGitlabProviderTokenManagement {
@@ -295,23 +688,62 @@ export interface ProjectAuthenticationOauthSystemGitlabProviderTokenManagement {
295
688
  redirectUrl?: pulumi.Input<string>;
296
689
  }
297
690
  export interface ProjectAuthenticationOauthSystemGoogle {
691
+ /**
692
+ * The URL that users are redirected to for authorization with the OAuth provider.
693
+ */
298
694
  authorizationEndpoint?: pulumi.Input<string>;
299
695
  claimMapping?: pulumi.Input<{
300
696
  [key: string]: pulumi.Input<string>;
301
697
  }>;
698
+ /**
699
+ * The client ID for the OAuth provider, used to identify the application to the provider.
700
+ */
302
701
  clientId?: pulumi.Input<string>;
702
+ /**
703
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
704
+ */
303
705
  clientSecret?: pulumi.Input<string>;
706
+ /**
707
+ * A brief description of the OAuth provider.
708
+ */
304
709
  description?: pulumi.Input<string>;
305
710
  disabled?: pulumi.Input<boolean>;
711
+ /**
712
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
713
+ */
306
714
  grantType?: pulumi.Input<string>;
307
715
  issuer?: pulumi.Input<string>;
716
+ /**
717
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
718
+ */
308
719
  jwksEndpoint?: pulumi.Input<string>;
720
+ /**
721
+ * The URL of the logo associated with the OAuth provider.
722
+ */
309
723
  logo?: pulumi.Input<string>;
724
+ /**
725
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
726
+ */
310
727
  mergeUserAccounts?: pulumi.Input<boolean>;
728
+ /**
729
+ * Custom prompts or consent screens that users may see during OAuth authentication.
730
+ */
311
731
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
732
+ /**
733
+ * Settings related to token management for the OAuth provider.
734
+ */
312
735
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemGoogleProviderTokenManagement>;
736
+ /**
737
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
738
+ */
313
739
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
740
+ /**
741
+ * The URL where the application requests an access token from the OAuth provider.
742
+ */
314
743
  tokenEndpoint?: pulumi.Input<string>;
744
+ /**
745
+ * The URL where the application retrieves user information from the OAuth provider.
746
+ */
315
747
  userInfoEndpoint?: pulumi.Input<string>;
316
748
  }
317
749
  export interface ProjectAuthenticationOauthSystemGoogleProviderTokenManagement {
@@ -319,23 +751,62 @@ export interface ProjectAuthenticationOauthSystemGoogleProviderTokenManagement {
319
751
  redirectUrl?: pulumi.Input<string>;
320
752
  }
321
753
  export interface ProjectAuthenticationOauthSystemLinkedin {
754
+ /**
755
+ * The URL that users are redirected to for authorization with the OAuth provider.
756
+ */
322
757
  authorizationEndpoint?: pulumi.Input<string>;
323
758
  claimMapping?: pulumi.Input<{
324
759
  [key: string]: pulumi.Input<string>;
325
760
  }>;
761
+ /**
762
+ * The client ID for the OAuth provider, used to identify the application to the provider.
763
+ */
326
764
  clientId?: pulumi.Input<string>;
765
+ /**
766
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
767
+ */
327
768
  clientSecret?: pulumi.Input<string>;
769
+ /**
770
+ * A brief description of the OAuth provider.
771
+ */
328
772
  description?: pulumi.Input<string>;
329
773
  disabled?: pulumi.Input<boolean>;
774
+ /**
775
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
776
+ */
330
777
  grantType?: pulumi.Input<string>;
331
778
  issuer?: pulumi.Input<string>;
779
+ /**
780
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
781
+ */
332
782
  jwksEndpoint?: pulumi.Input<string>;
783
+ /**
784
+ * The URL of the logo associated with the OAuth provider.
785
+ */
333
786
  logo?: pulumi.Input<string>;
787
+ /**
788
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
789
+ */
334
790
  mergeUserAccounts?: pulumi.Input<boolean>;
791
+ /**
792
+ * Custom prompts or consent screens that users may see during OAuth authentication.
793
+ */
335
794
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
795
+ /**
796
+ * Settings related to token management for the OAuth provider.
797
+ */
336
798
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemLinkedinProviderTokenManagement>;
799
+ /**
800
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
801
+ */
337
802
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
803
+ /**
804
+ * The URL where the application requests an access token from the OAuth provider.
805
+ */
338
806
  tokenEndpoint?: pulumi.Input<string>;
807
+ /**
808
+ * The URL where the application retrieves user information from the OAuth provider.
809
+ */
339
810
  userInfoEndpoint?: pulumi.Input<string>;
340
811
  }
341
812
  export interface ProjectAuthenticationOauthSystemLinkedinProviderTokenManagement {
@@ -343,23 +814,62 @@ export interface ProjectAuthenticationOauthSystemLinkedinProviderTokenManagement
343
814
  redirectUrl?: pulumi.Input<string>;
344
815
  }
345
816
  export interface ProjectAuthenticationOauthSystemMicrosoft {
817
+ /**
818
+ * The URL that users are redirected to for authorization with the OAuth provider.
819
+ */
346
820
  authorizationEndpoint?: pulumi.Input<string>;
347
821
  claimMapping?: pulumi.Input<{
348
822
  [key: string]: pulumi.Input<string>;
349
823
  }>;
824
+ /**
825
+ * The client ID for the OAuth provider, used to identify the application to the provider.
826
+ */
350
827
  clientId?: pulumi.Input<string>;
828
+ /**
829
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
830
+ */
351
831
  clientSecret?: pulumi.Input<string>;
832
+ /**
833
+ * A brief description of the OAuth provider.
834
+ */
352
835
  description?: pulumi.Input<string>;
353
836
  disabled?: pulumi.Input<boolean>;
837
+ /**
838
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
839
+ */
354
840
  grantType?: pulumi.Input<string>;
355
841
  issuer?: pulumi.Input<string>;
842
+ /**
843
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
844
+ */
356
845
  jwksEndpoint?: pulumi.Input<string>;
846
+ /**
847
+ * The URL of the logo associated with the OAuth provider.
848
+ */
357
849
  logo?: pulumi.Input<string>;
850
+ /**
851
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
852
+ */
358
853
  mergeUserAccounts?: pulumi.Input<boolean>;
854
+ /**
855
+ * Custom prompts or consent screens that users may see during OAuth authentication.
856
+ */
359
857
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
858
+ /**
859
+ * Settings related to token management for the OAuth provider.
860
+ */
360
861
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemMicrosoftProviderTokenManagement>;
862
+ /**
863
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
864
+ */
361
865
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
866
+ /**
867
+ * The URL where the application requests an access token from the OAuth provider.
868
+ */
362
869
  tokenEndpoint?: pulumi.Input<string>;
870
+ /**
871
+ * The URL where the application retrieves user information from the OAuth provider.
872
+ */
363
873
  userInfoEndpoint?: pulumi.Input<string>;
364
874
  }
365
875
  export interface ProjectAuthenticationOauthSystemMicrosoftProviderTokenManagement {
@@ -367,23 +877,62 @@ export interface ProjectAuthenticationOauthSystemMicrosoftProviderTokenManagemen
367
877
  redirectUrl?: pulumi.Input<string>;
368
878
  }
369
879
  export interface ProjectAuthenticationOauthSystemSlack {
880
+ /**
881
+ * The URL that users are redirected to for authorization with the OAuth provider.
882
+ */
370
883
  authorizationEndpoint?: pulumi.Input<string>;
371
884
  claimMapping?: pulumi.Input<{
372
885
  [key: string]: pulumi.Input<string>;
373
886
  }>;
887
+ /**
888
+ * The client ID for the OAuth provider, used to identify the application to the provider.
889
+ */
374
890
  clientId?: pulumi.Input<string>;
891
+ /**
892
+ * The client secret for the OAuth provider, used to authenticate the application with the provider.
893
+ */
375
894
  clientSecret?: pulumi.Input<string>;
895
+ /**
896
+ * A brief description of the OAuth provider.
897
+ */
376
898
  description?: pulumi.Input<string>;
377
899
  disabled?: pulumi.Input<boolean>;
900
+ /**
901
+ * The type of grant (`authorizationCode` or `implicit`) to use when requesting access tokens from the OAuth provider.
902
+ */
378
903
  grantType?: pulumi.Input<string>;
379
904
  issuer?: pulumi.Input<string>;
905
+ /**
906
+ * The URL where the application can retrieve JSON Web Key Sets (JWKS) for the OAuth provider.
907
+ */
380
908
  jwksEndpoint?: pulumi.Input<string>;
909
+ /**
910
+ * The URL of the logo associated with the OAuth provider.
911
+ */
381
912
  logo?: pulumi.Input<string>;
913
+ /**
914
+ * Whether to merge existing user accounts with new ones created through OAuth authentication.
915
+ */
382
916
  mergeUserAccounts?: pulumi.Input<boolean>;
917
+ /**
918
+ * Custom prompts or consent screens that users may see during OAuth authentication.
919
+ */
383
920
  prompts?: pulumi.Input<pulumi.Input<string>[]>;
921
+ /**
922
+ * Settings related to token management for the OAuth provider.
923
+ */
384
924
  providerTokenManagement?: pulumi.Input<inputs.ProjectAuthenticationOauthSystemSlackProviderTokenManagement>;
925
+ /**
926
+ * Scopes of access that the application requests from the user's account on the OAuth provider.
927
+ */
385
928
  scopes?: pulumi.Input<pulumi.Input<string>[]>;
929
+ /**
930
+ * The URL where the application requests an access token from the OAuth provider.
931
+ */
386
932
  tokenEndpoint?: pulumi.Input<string>;
933
+ /**
934
+ * The URL where the application retrieves user information from the OAuth provider.
935
+ */
387
936
  userInfoEndpoint?: pulumi.Input<string>;
388
937
  }
389
938
  export interface ProjectAuthenticationOauthSystemSlackProviderTokenManagement {
@@ -391,12 +940,27 @@ export interface ProjectAuthenticationOauthSystemSlackProviderTokenManagement {
391
940
  redirectUrl?: pulumi.Input<string>;
392
941
  }
393
942
  export interface ProjectAuthenticationOtp {
943
+ /**
944
+ * The domain to embed in OTP messages.
945
+ */
394
946
  domain?: pulumi.Input<string>;
947
+ /**
948
+ * Settings related to sending emails with OTP codes.
949
+ */
395
950
  emailService?: pulumi.Input<inputs.ProjectAuthenticationOtpEmailService>;
396
951
  enabled?: pulumi.Input<boolean>;
952
+ /**
953
+ * The amount of time that an OTP code will be valid for.
954
+ */
397
955
  expirationTime?: pulumi.Input<number>;
398
956
  expirationTimeUnit?: pulumi.Input<string>;
957
+ /**
958
+ * Settings related to sending SMS messages with OTP codes.
959
+ */
399
960
  textService?: pulumi.Input<inputs.ProjectAuthenticationOtpTextService>;
961
+ /**
962
+ * Settings related to voice calls with OTP codes.
963
+ */
400
964
  voiceService?: pulumi.Input<inputs.ProjectAuthenticationOtpVoiceService>;
401
965
  }
402
966
  export interface ProjectAuthenticationOtpEmailService {
@@ -432,19 +996,59 @@ export interface ProjectAuthenticationOtpVoiceServiceTemplate {
432
996
  id?: pulumi.Input<string>;
433
997
  name: pulumi.Input<string>;
434
998
  }
999
+ export interface ProjectAuthenticationPasskeys {
1000
+ enabled?: pulumi.Input<boolean>;
1001
+ /**
1002
+ * Passkeys will be usable in the following domain and all its subdomains.
1003
+ */
1004
+ topLevelDomain?: pulumi.Input<string>;
1005
+ }
435
1006
  export interface ProjectAuthenticationPassword {
1007
+ /**
1008
+ * Settings related to sending password reset emails as part of the password feature.
1009
+ */
436
1010
  emailService?: pulumi.Input<inputs.ProjectAuthenticationPasswordEmailService>;
437
1011
  enabled?: pulumi.Input<boolean>;
1012
+ /**
1013
+ * Whether users are required to change their password periodically.
1014
+ */
438
1015
  expiration?: pulumi.Input<boolean>;
1016
+ /**
1017
+ * The number of weeks after which a user's password expires and they need to replace it.
1018
+ */
439
1019
  expirationWeeks?: pulumi.Input<number>;
1020
+ /**
1021
+ * Whether the user account should be locked after a specified number of failed login attempts.
1022
+ */
440
1023
  lock?: pulumi.Input<boolean>;
1024
+ /**
1025
+ * The number of failed login attempts allowed before an account is locked.
1026
+ */
441
1027
  lockAttempts?: pulumi.Input<number>;
1028
+ /**
1029
+ * Whether passwords must contain at least one lowercase letter.
1030
+ */
442
1031
  lowercase?: pulumi.Input<boolean>;
1032
+ /**
1033
+ * The minimum length of the password that users are required to use. The maximum length is always `64`.
1034
+ */
443
1035
  minLength?: pulumi.Input<number>;
1036
+ /**
1037
+ * Whether passwords must contain at least one non-alphanumeric character (e.g. `!`, `@`, `#`).
1038
+ */
444
1039
  nonAlphanumeric?: pulumi.Input<boolean>;
1040
+ /**
1041
+ * Whether passwords must contain at least one number.
1042
+ */
445
1043
  number?: pulumi.Input<boolean>;
1044
+ /**
1045
+ * Whether to forbid password reuse when users change their password.
1046
+ */
446
1047
  reuse?: pulumi.Input<boolean>;
447
1048
  reuseAmount?: pulumi.Input<number>;
1049
+ /**
1050
+ * Whether passwords must contain at least one uppercase letter.
1051
+ */
448
1052
  uppercase?: pulumi.Input<boolean>;
449
1053
  }
450
1054
  export interface ProjectAuthenticationPasswordEmailService {
@@ -462,15 +1066,14 @@ export interface ProjectAuthenticationPasswordEmailServiceTemplate {
462
1066
  }
463
1067
  export interface ProjectAuthenticationSso {
464
1068
  enabled?: pulumi.Input<boolean>;
1069
+ /**
1070
+ * Whether to merge existing user accounts with new ones created through SSO authentication.
1071
+ */
465
1072
  mergeUsers?: pulumi.Input<boolean>;
466
1073
  }
467
1074
  export interface ProjectAuthenticationTotp {
468
1075
  enabled?: pulumi.Input<boolean>;
469
1076
  }
470
- export interface ProjectAuthenticationWebauthn {
471
- enabled?: pulumi.Input<boolean>;
472
- topLevelDomain?: pulumi.Input<string>;
473
- }
474
1077
  export interface ProjectAuthorization {
475
1078
  permissions?: pulumi.Input<pulumi.Input<inputs.ProjectAuthorizationPermission>[]>;
476
1079
  roles?: pulumi.Input<pulumi.Input<inputs.ProjectAuthorizationRole>[]>;
@@ -487,64 +1090,172 @@ export interface ProjectAuthorizationRole {
487
1090
  permissions?: pulumi.Input<pulumi.Input<string>[]>;
488
1091
  }
489
1092
  export interface ProjectConnectors {
1093
+ /**
1094
+ * AbuseIPDB provides an API to identify if an IP address has been associated with malicious activities online.
1095
+ */
490
1096
  abuseipdbs?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsAbuseipdb>[]>;
1097
+ /**
1098
+ * Amplitude, an analytics product that allows you to collects events from web and mobile apps, unify those and use those to better understand your customers needs.
1099
+ */
491
1100
  amplitudes?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsAmplitude>[]>;
492
1101
  auditWebhooks?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsAuditWebhook>[]>;
493
1102
  awsS3s?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsAwsS3>[]>;
494
1103
  awsTranslates?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsAwsTranslate>[]>;
1104
+ /**
1105
+ * An identity verification platform that allow customers to digitally verify their identity from anywhere.
1106
+ */
495
1107
  clears?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsClear>[]>;
1108
+ /**
1109
+ * Datadog, an observability service for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.
1110
+ */
496
1111
  datadogs?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsDatadog>[]>;
497
1112
  devrevGrows?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsDevrevGrow>[]>;
1113
+ /**
1114
+ * Docebo is a cloud-based Learning Management System (LMS) designed to increase performance and learning engagement.
1115
+ */
498
1116
  docebos?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsDocebo>[]>;
499
1117
  fingerprintDescopes?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsFingerprintDescope>[]>;
1118
+ /**
1119
+ * Use the Fingerprint (formerly FingerprintJS) connector to add device intelligence and prevent fraud.
1120
+ */
500
1121
  fingerprints?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsFingerprint>[]>;
1122
+ /**
1123
+ * Use the Forter connector for account fraud prevention.
1124
+ */
501
1125
  forters?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsForter>[]>;
502
1126
  googleCloudTranslations?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsGoogleCloudTranslation>[]>;
1127
+ /**
1128
+ * API to check if password appeared previously exposed in data breaches.
1129
+ */
503
1130
  hibps?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsHibp>[]>;
504
1131
  httpStaticIps?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsHttpStaticIp>[]>;
1132
+ /**
1133
+ * A general purpose HTTP client
1134
+ */
505
1135
  https?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsHttp>[]>;
1136
+ /**
1137
+ * HubSpot is a CRM platform with software, integrations, and resources needed to connect marketing, sales, content management, and customer service.
1138
+ */
506
1139
  hubspots?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsHubspot>[]>;
1140
+ /**
1141
+ * Intercom is a Conversational Relationship Platform (CRP).
1142
+ */
507
1143
  intercoms?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsIntercom>[]>;
1144
+ /**
1145
+ * Use this connector to send audit events and troubleshooting logs to New Relic.
1146
+ */
508
1147
  newrelics?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsNewrelic>[]>;
509
1148
  recaptchaEnterprises?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsRecaptchaEnterprise>[]>;
1149
+ /**
1150
+ * reCAPTCHA is a free google service that protects your site from spam and abuse. It uses advanced risk analysis techniques to tell humans and bots apart.
1151
+ */
510
1152
  recaptchas?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsRecaptcha>[]>;
1153
+ /**
1154
+ * AWS Rekognition, cloud-based AI service that offers computer vision capabilities for analyzing and processing images. Useful for registration and verification processes, and can be used to detect fraud and prevent identity theft.
1155
+ */
511
1156
  rekognitions?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsRekognition>[]>;
1157
+ /**
1158
+ * Salesforce is a leading cloud-based Customer Relationship Management (CRM) platform that helps businesses streamline their sales, service, and marketing operations.
1159
+ */
512
1160
  salesforces?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsSalesforce>[]>;
1161
+ /**
1162
+ * Segment, an analytics product that allows you to collects events from web and mobile apps, unify those and use those to better understand your customers needs.
1163
+ */
513
1164
  segments?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsSegment>[]>;
514
1165
  sendgrids?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsSendgrid>[]>;
515
1166
  smtps?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsSmtp>[]>;
1167
+ /**
1168
+ * Sumo Logic, fast troubleshooting and investigation with AI/ML-powered log analytics
1169
+ */
516
1170
  sumologics?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsSumologic>[]>;
1171
+ /**
1172
+ * Telesign Phone number intelligence API provides risk score for phone numbers.
1173
+ */
517
1174
  telesigns?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsTelesign>[]>;
1175
+ /**
1176
+ * API security for a cloud-first, API-driven world.
1177
+ */
518
1178
  traceables?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsTraceable>[]>;
519
1179
  twilioCores?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsTwilioCore>[]>;
520
1180
  twilioVerifies?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsTwilioVerify>[]>;
1181
+ /**
1182
+ * AI-powered identity verification solution for identity fraud prevention, Know Your Customer compliance, and fast conversions of valuable customers.
1183
+ */
521
1184
  veriffs?: pulumi.Input<pulumi.Input<inputs.ProjectConnectorsVeriff>[]>;
522
1185
  }
523
1186
  export interface ProjectConnectorsAbuseipdb {
1187
+ /**
1188
+ * The unique AbuseIPDB API key.
1189
+ */
524
1190
  apiKey: pulumi.Input<string>;
1191
+ /**
1192
+ * A description of what your connector is used for.
1193
+ */
525
1194
  description?: pulumi.Input<string>;
526
1195
  id?: pulumi.Input<string>;
1196
+ /**
1197
+ * A custom name for your connector.
1198
+ */
527
1199
  name: pulumi.Input<string>;
528
1200
  }
529
1201
  export interface ProjectConnectorsAmplitude {
1202
+ /**
1203
+ * The Amplitude API Key generated for the Descope service.
1204
+ */
530
1205
  apiKey: pulumi.Input<string>;
1206
+ /**
1207
+ * A description of what your connector is used for.
1208
+ */
531
1209
  description?: pulumi.Input<string>;
532
1210
  id?: pulumi.Input<string>;
1211
+ /**
1212
+ * A custom name for your connector.
1213
+ */
533
1214
  name: pulumi.Input<string>;
1215
+ /**
1216
+ * The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
1217
+ */
534
1218
  serverUrl?: pulumi.Input<string>;
1219
+ /**
1220
+ * `EU` or `US`. Sets the Amplitude server zone. Set this to `EU` for Amplitude projects created in `EU` data center. Default is `US`.
1221
+ */
535
1222
  serverZone?: pulumi.Input<string>;
536
1223
  }
537
1224
  export interface ProjectConnectorsAuditWebhook {
1225
+ /**
1226
+ * Specify which events will be sent to the external audit service (including tenant selection).
1227
+ */
538
1228
  auditFilters?: pulumi.Input<string>;
1229
+ /**
1230
+ * Authentication Information
1231
+ */
539
1232
  authentication?: pulumi.Input<inputs.ProjectConnectorsAuditWebhookAuthentication>;
1233
+ /**
1234
+ * The base URL to fetch
1235
+ */
540
1236
  baseUrl: pulumi.Input<string>;
1237
+ /**
1238
+ * A description of what your connector is used for.
1239
+ */
541
1240
  description?: pulumi.Input<string>;
1241
+ /**
1242
+ * The headers to send with the request
1243
+ */
542
1244
  headers?: pulumi.Input<{
543
1245
  [key: string]: pulumi.Input<string>;
544
1246
  }>;
1247
+ /**
1248
+ * HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the payload, and the resulting signature will be sent in the `x-descope-webhook-s256` header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
1249
+ */
545
1250
  hmacSecret?: pulumi.Input<string>;
546
1251
  id?: pulumi.Input<string>;
1252
+ /**
1253
+ * Will ignore certificate errors raised by the client
1254
+ */
547
1255
  insecure?: pulumi.Input<boolean>;
1256
+ /**
1257
+ * A custom name for your connector.
1258
+ */
548
1259
  name: pulumi.Input<string>;
549
1260
  }
550
1261
  export interface ProjectConnectorsAuditWebhookAuthentication {
@@ -561,108 +1272,291 @@ export interface ProjectConnectorsAuditWebhookAuthenticationBasic {
561
1272
  username: pulumi.Input<string>;
562
1273
  }
563
1274
  export interface ProjectConnectorsAwsS3 {
1275
+ /**
1276
+ * The unique AWS access key ID.
1277
+ */
564
1278
  accessKeyId: pulumi.Input<string>;
565
1279
  auditEnabled?: pulumi.Input<boolean>;
566
1280
  auditFilters?: pulumi.Input<string>;
1281
+ /**
1282
+ * The AWS S3 bucket. This bucket should already exist for the connector to work.
1283
+ */
567
1284
  bucket: pulumi.Input<string>;
1285
+ /**
1286
+ * A description of what your connector is used for.
1287
+ */
568
1288
  description?: pulumi.Input<string>;
569
1289
  id?: pulumi.Input<string>;
1290
+ /**
1291
+ * A custom name for your connector.
1292
+ */
570
1293
  name: pulumi.Input<string>;
1294
+ /**
1295
+ * The AWS S3 region, e.g. `us-east-1`.
1296
+ */
571
1297
  region: pulumi.Input<string>;
1298
+ /**
1299
+ * The secret AWS access key.
1300
+ */
572
1301
  secretAccessKey: pulumi.Input<string>;
573
1302
  troubleshootLogEnabled?: pulumi.Input<boolean>;
574
1303
  }
575
1304
  export interface ProjectConnectorsAwsTranslate {
1305
+ /**
1306
+ * AWS access key ID.
1307
+ */
576
1308
  accessKeyId: pulumi.Input<string>;
1309
+ /**
1310
+ * A description of what your connector is used for.
1311
+ */
577
1312
  description?: pulumi.Input<string>;
578
1313
  id?: pulumi.Input<string>;
1314
+ /**
1315
+ * A custom name for your connector.
1316
+ */
579
1317
  name: pulumi.Input<string>;
1318
+ /**
1319
+ * The AWS region to which this client will send requests. (e.g. us-east-1.)
1320
+ */
580
1321
  region: pulumi.Input<string>;
1322
+ /**
1323
+ * AWS secret access key.
1324
+ */
581
1325
  secretAccessKey: pulumi.Input<string>;
1326
+ /**
1327
+ * (Optional) A security or session token to use with these credentials. Usually present for temporary credentials.
1328
+ */
582
1329
  sessionToken?: pulumi.Input<string>;
583
1330
  }
584
1331
  export interface ProjectConnectorsClear {
1332
+ /**
1333
+ * Your CLEAR API key.
1334
+ */
585
1335
  apiKey: pulumi.Input<string>;
1336
+ /**
1337
+ * A description of what your connector is used for.
1338
+ */
586
1339
  description?: pulumi.Input<string>;
587
1340
  id?: pulumi.Input<string>;
1341
+ /**
1342
+ * A custom name for your connector.
1343
+ */
588
1344
  name: pulumi.Input<string>;
1345
+ /**
1346
+ * Your CLEAR project ID.
1347
+ */
589
1348
  projectId: pulumi.Input<string>;
590
1349
  }
591
1350
  export interface ProjectConnectorsDatadog {
1351
+ /**
1352
+ * The unique Datadog organization key.
1353
+ */
592
1354
  apiKey: pulumi.Input<string>;
593
1355
  auditEnabled?: pulumi.Input<boolean>;
594
1356
  auditFilters?: pulumi.Input<string>;
1357
+ /**
1358
+ * A description of what your connector is used for.
1359
+ */
595
1360
  description?: pulumi.Input<string>;
596
1361
  id?: pulumi.Input<string>;
1362
+ /**
1363
+ * A custom name for your connector.
1364
+ */
597
1365
  name: pulumi.Input<string>;
1366
+ /**
1367
+ * The Datadog site to send logs to. Default is `datadoghq.com`. European, free tier and other customers should set their site accordingly.
1368
+ */
598
1369
  site?: pulumi.Input<string>;
599
1370
  troubleshootLogEnabled?: pulumi.Input<boolean>;
600
1371
  }
601
1372
  export interface ProjectConnectorsDevrevGrow {
1373
+ /**
1374
+ * Authentication to DevRev APIs requires a personal access token (PAT).
1375
+ */
602
1376
  apiKey: pulumi.Input<string>;
1377
+ /**
1378
+ * A description of what your connector is used for.
1379
+ */
603
1380
  description?: pulumi.Input<string>;
604
1381
  id?: pulumi.Input<string>;
1382
+ /**
1383
+ * A custom name for your connector.
1384
+ */
605
1385
  name: pulumi.Input<string>;
606
1386
  }
607
1387
  export interface ProjectConnectorsDocebo {
1388
+ /**
1389
+ * The Docebo api base url.
1390
+ */
608
1391
  baseUrl: pulumi.Input<string>;
1392
+ /**
1393
+ * The Docebo OAuth 2.0 app client ID.
1394
+ */
609
1395
  clientId: pulumi.Input<string>;
1396
+ /**
1397
+ * The Docebo OAuth 2.0 app client secret.
1398
+ */
610
1399
  clientSecret: pulumi.Input<string>;
1400
+ /**
1401
+ * A description of what your connector is used for.
1402
+ */
611
1403
  description?: pulumi.Input<string>;
612
1404
  id?: pulumi.Input<string>;
1405
+ /**
1406
+ * A custom name for your connector.
1407
+ */
613
1408
  name: pulumi.Input<string>;
1409
+ /**
1410
+ * The Docebo user's password.
1411
+ */
614
1412
  password: pulumi.Input<string>;
1413
+ /**
1414
+ * The Docebo username.
1415
+ */
615
1416
  username: pulumi.Input<string>;
616
1417
  }
617
1418
  export interface ProjectConnectorsFingerprint {
1419
+ /**
1420
+ * The Cloudflare integration Endpoint URL.
1421
+ */
618
1422
  cloudflareEndpointUrl?: pulumi.Input<string>;
1423
+ /**
1424
+ * The Cloudflare integration Script URL.
1425
+ */
619
1426
  cloudflareScriptUrl?: pulumi.Input<string>;
1427
+ /**
1428
+ * A description of what your connector is used for.
1429
+ */
620
1430
  description?: pulumi.Input<string>;
621
1431
  id?: pulumi.Input<string>;
1432
+ /**
1433
+ * A custom name for your connector.
1434
+ */
622
1435
  name: pulumi.Input<string>;
1436
+ /**
1437
+ * The Fingerprint public API key.
1438
+ */
623
1439
  publicApiKey: pulumi.Input<string>;
1440
+ /**
1441
+ * The Fingerprint secret API key.
1442
+ */
624
1443
  secretApiKey: pulumi.Input<string>;
1444
+ /**
1445
+ * Enable to configure the relevant Cloudflare integration parameters if Cloudflare integration is set in your Fingerprint account.
1446
+ */
625
1447
  useCloudflareIntegration?: pulumi.Input<boolean>;
626
1448
  }
627
1449
  export interface ProjectConnectorsFingerprintDescope {
1450
+ /**
1451
+ * The custom domain to fetch
1452
+ */
628
1453
  customDomain?: pulumi.Input<string>;
1454
+ /**
1455
+ * A description of what your connector is used for.
1456
+ */
629
1457
  description?: pulumi.Input<string>;
630
1458
  id?: pulumi.Input<string>;
1459
+ /**
1460
+ * A custom name for your connector.
1461
+ */
631
1462
  name: pulumi.Input<string>;
632
1463
  }
633
1464
  export interface ProjectConnectorsForter {
1465
+ /**
1466
+ * A description of what your connector is used for.
1467
+ */
634
1468
  description?: pulumi.Input<string>;
635
1469
  id?: pulumi.Input<string>;
1470
+ /**
1471
+ * A custom name for your connector.
1472
+ */
636
1473
  name: pulumi.Input<string>;
1474
+ /**
1475
+ * Override the user IP address.
1476
+ */
637
1477
  overrideIpAddress?: pulumi.Input<string>;
1478
+ /**
1479
+ * Override the user email.
1480
+ */
638
1481
  overrideUserEmail?: pulumi.Input<string>;
1482
+ /**
1483
+ * Override the user's IP address or email so that Forter can provide a specific decision or recommendation. Contact the Forter team for further details. Note: Overriding the user IP address or email is intended for testing purpose and should not be utilized in production environments.
1484
+ */
639
1485
  overrides?: pulumi.Input<boolean>;
1486
+ /**
1487
+ * The Forter secret key.
1488
+ */
640
1489
  secretKey: pulumi.Input<string>;
1490
+ /**
1491
+ * The Forter site ID.
1492
+ */
641
1493
  siteId: pulumi.Input<string>;
642
1494
  }
643
1495
  export interface ProjectConnectorsGoogleCloudTranslation {
1496
+ /**
1497
+ * A description of what your connector is used for.
1498
+ */
644
1499
  description?: pulumi.Input<string>;
645
1500
  id?: pulumi.Input<string>;
1501
+ /**
1502
+ * A custom name for your connector.
1503
+ */
646
1504
  name: pulumi.Input<string>;
1505
+ /**
1506
+ * The Google Cloud project ID where the Google Cloud Translation is managed.
1507
+ */
647
1508
  projectId: pulumi.Input<string>;
1509
+ /**
1510
+ * Service Account JSON associated with the current project.
1511
+ */
648
1512
  serviceAccountJson: pulumi.Input<string>;
649
1513
  }
650
1514
  export interface ProjectConnectorsHibp {
1515
+ /**
1516
+ * A description of what your connector is used for.
1517
+ */
651
1518
  description?: pulumi.Input<string>;
652
1519
  id?: pulumi.Input<string>;
1520
+ /**
1521
+ * A custom name for your connector.
1522
+ */
653
1523
  name: pulumi.Input<string>;
654
1524
  }
655
1525
  export interface ProjectConnectorsHttp {
1526
+ /**
1527
+ * Authentication Information
1528
+ */
656
1529
  authentication?: pulumi.Input<inputs.ProjectConnectorsHttpAuthentication>;
1530
+ /**
1531
+ * The base URL to fetch
1532
+ */
657
1533
  baseUrl: pulumi.Input<string>;
1534
+ /**
1535
+ * A description of what your connector is used for.
1536
+ */
658
1537
  description?: pulumi.Input<string>;
1538
+ /**
1539
+ * The headers to send with the request
1540
+ */
659
1541
  headers?: pulumi.Input<{
660
1542
  [key: string]: pulumi.Input<string>;
661
1543
  }>;
1544
+ /**
1545
+ * HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the `x-descope-webhook-s256` header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
1546
+ */
662
1547
  hmacSecret?: pulumi.Input<string>;
663
1548
  id?: pulumi.Input<string>;
1549
+ /**
1550
+ * The connector response context will also include the headers. The context will have a "body" attribute and a "headers" attribute. See more details in the help guide
1551
+ */
664
1552
  includeHeadersInContext?: pulumi.Input<boolean>;
1553
+ /**
1554
+ * Will ignore certificate errors raised by the client
1555
+ */
665
1556
  insecure?: pulumi.Input<boolean>;
1557
+ /**
1558
+ * A custom name for your connector.
1559
+ */
666
1560
  name: pulumi.Input<string>;
667
1561
  }
668
1562
  export interface ProjectConnectorsHttpAuthentication {
@@ -679,16 +1573,40 @@ export interface ProjectConnectorsHttpAuthenticationBasic {
679
1573
  username: pulumi.Input<string>;
680
1574
  }
681
1575
  export interface ProjectConnectorsHttpStaticIp {
1576
+ /**
1577
+ * Authentication Information
1578
+ */
682
1579
  authentication?: pulumi.Input<inputs.ProjectConnectorsHttpStaticIpAuthentication>;
1580
+ /**
1581
+ * The base URL to fetch
1582
+ */
683
1583
  baseUrl: pulumi.Input<string>;
1584
+ /**
1585
+ * A description of what your connector is used for.
1586
+ */
684
1587
  description?: pulumi.Input<string>;
1588
+ /**
1589
+ * The headers to send with the request
1590
+ */
685
1591
  headers?: pulumi.Input<{
686
1592
  [key: string]: pulumi.Input<string>;
687
1593
  }>;
1594
+ /**
1595
+ * HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the `x-descope-webhook-s256` header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
1596
+ */
688
1597
  hmacSecret?: pulumi.Input<string>;
689
1598
  id?: pulumi.Input<string>;
1599
+ /**
1600
+ * The connector response context will also include the headers. The context will have a "body" attribute and a "headers" attribute. See more details in the help guide
1601
+ */
690
1602
  includeHeadersInContext?: pulumi.Input<boolean>;
1603
+ /**
1604
+ * Will ignore certificate errors raised by the client
1605
+ */
691
1606
  insecure?: pulumi.Input<boolean>;
1607
+ /**
1608
+ * A custom name for your connector.
1609
+ */
692
1610
  name: pulumi.Input<string>;
693
1611
  }
694
1612
  export interface ProjectConnectorsHttpStaticIpAuthentication {
@@ -705,76 +1623,202 @@ export interface ProjectConnectorsHttpStaticIpAuthenticationBasic {
705
1623
  username: pulumi.Input<string>;
706
1624
  }
707
1625
  export interface ProjectConnectorsHubspot {
1626
+ /**
1627
+ * The HubSpot private API access token generated for the Descope service.
1628
+ */
708
1629
  accessToken: pulumi.Input<string>;
1630
+ /**
1631
+ * The base URL of the HubSpot API, when using a custom domain in HubSpot, default value is https://api.hubapi.com .
1632
+ */
709
1633
  baseUrl?: pulumi.Input<string>;
1634
+ /**
1635
+ * A description of what your connector is used for.
1636
+ */
710
1637
  description?: pulumi.Input<string>;
711
1638
  id?: pulumi.Input<string>;
1639
+ /**
1640
+ * A custom name for your connector.
1641
+ */
712
1642
  name: pulumi.Input<string>;
713
1643
  }
714
1644
  export interface ProjectConnectorsIntercom {
1645
+ /**
1646
+ * A description of what your connector is used for.
1647
+ */
715
1648
  description?: pulumi.Input<string>;
716
1649
  id?: pulumi.Input<string>;
1650
+ /**
1651
+ * A custom name for your connector.
1652
+ */
717
1653
  name: pulumi.Input<string>;
1654
+ /**
1655
+ * Regional Hosting - US, EU, or AU. default: US
1656
+ */
718
1657
  region?: pulumi.Input<string>;
1658
+ /**
1659
+ * The Intercom access token.
1660
+ */
719
1661
  token: pulumi.Input<string>;
720
1662
  }
721
1663
  export interface ProjectConnectorsNewrelic {
1664
+ /**
1665
+ * Ingest License Key of the account you want to report data to.
1666
+ */
722
1667
  apiKey: pulumi.Input<string>;
723
1668
  auditEnabled?: pulumi.Input<boolean>;
724
1669
  auditFilters?: pulumi.Input<string>;
1670
+ /**
1671
+ * The New Relic data center the account belongs to. Possible values are: `US`, `EU`, `FedRAMP`. Default is `US`.
1672
+ */
725
1673
  dataCenter?: pulumi.Input<string>;
1674
+ /**
1675
+ * A description of what your connector is used for.
1676
+ */
726
1677
  description?: pulumi.Input<string>;
727
1678
  id?: pulumi.Input<string>;
1679
+ /**
1680
+ * Specify a custom prefix for all log fields. The default prefix is `descope.`.
1681
+ */
728
1682
  logsPrefix?: pulumi.Input<string>;
1683
+ /**
1684
+ * A custom name for your connector.
1685
+ */
729
1686
  name: pulumi.Input<string>;
1687
+ /**
1688
+ * Enable this option to use a custom prefix for log fields.
1689
+ */
730
1690
  overrideLogsPrefix?: pulumi.Input<boolean>;
731
1691
  troubleshootLogEnabled?: pulumi.Input<boolean>;
732
1692
  }
733
1693
  export interface ProjectConnectorsRecaptcha {
1694
+ /**
1695
+ * A description of what your connector is used for.
1696
+ */
734
1697
  description?: pulumi.Input<string>;
735
1698
  id?: pulumi.Input<string>;
1699
+ /**
1700
+ * A custom name for your connector.
1701
+ */
736
1702
  name: pulumi.Input<string>;
1703
+ /**
1704
+ * The secret key authorizes communication between Descope backend and the reCAPTCHA server to verify the user's response.
1705
+ */
737
1706
  secretKey: pulumi.Input<string>;
1707
+ /**
1708
+ * The site key is used to invoke reCAPTCHA service on your site or mobile application.
1709
+ */
738
1710
  siteKey: pulumi.Input<string>;
739
1711
  }
740
1712
  export interface ProjectConnectorsRecaptchaEnterprise {
1713
+ /**
1714
+ * API key associated with the current project.
1715
+ */
741
1716
  apiKey: pulumi.Input<string>;
1717
+ /**
1718
+ * When configured, the Recaptcha action will return the score without assessing the request. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot.
1719
+ */
742
1720
  assessmentScore?: pulumi.Input<number>;
1721
+ /**
1722
+ * A description of what your connector is used for.
1723
+ */
743
1724
  description?: pulumi.Input<string>;
744
1725
  id?: pulumi.Input<string>;
1726
+ /**
1727
+ * A custom name for your connector.
1728
+ */
745
1729
  name: pulumi.Input<string>;
1730
+ /**
1731
+ * Override the default assessment model. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
1732
+ */
746
1733
  overrideAssessment?: pulumi.Input<boolean>;
1734
+ /**
1735
+ * The Google Cloud project ID where the reCAPTCHA Enterprise is managed.
1736
+ */
747
1737
  projectId: pulumi.Input<string>;
1738
+ /**
1739
+ * The site key is used to invoke reCAPTCHA Enterprise service on your site or mobile application.
1740
+ */
748
1741
  siteKey: pulumi.Input<string>;
749
1742
  }
750
1743
  export interface ProjectConnectorsRekognition {
1744
+ /**
1745
+ * The AWS access key ID
1746
+ */
751
1747
  accessKeyId: pulumi.Input<string>;
1748
+ /**
1749
+ * The collection to store registered users in. Should match `[a-zA-Z0-9_.-]+` pattern. Changing this will cause losing existing users.
1750
+ */
752
1751
  collectionId: pulumi.Input<string>;
1752
+ /**
1753
+ * A description of what your connector is used for.
1754
+ */
753
1755
  description?: pulumi.Input<string>;
754
1756
  id?: pulumi.Input<string>;
1757
+ /**
1758
+ * A custom name for your connector.
1759
+ */
755
1760
  name: pulumi.Input<string>;
1761
+ /**
1762
+ * The AWS secret access key
1763
+ */
756
1764
  secretAccessKey: pulumi.Input<string>;
757
1765
  }
758
1766
  export interface ProjectConnectorsSalesforce {
1767
+ /**
1768
+ * The Salesforce API base URL.
1769
+ */
759
1770
  baseUrl: pulumi.Input<string>;
1771
+ /**
1772
+ * The consumer key of the connected app.
1773
+ */
760
1774
  clientId: pulumi.Input<string>;
1775
+ /**
1776
+ * The consumer secret of the connected app.
1777
+ */
761
1778
  clientSecret: pulumi.Input<string>;
1779
+ /**
1780
+ * A description of what your connector is used for.
1781
+ */
762
1782
  description?: pulumi.Input<string>;
763
1783
  id?: pulumi.Input<string>;
1784
+ /**
1785
+ * A custom name for your connector.
1786
+ */
764
1787
  name: pulumi.Input<string>;
1788
+ /**
1789
+ * REST API Version.
1790
+ */
765
1791
  version: pulumi.Input<string>;
766
1792
  }
767
1793
  export interface ProjectConnectorsSegment {
1794
+ /**
1795
+ * A description of what your connector is used for.
1796
+ */
768
1797
  description?: pulumi.Input<string>;
1798
+ /**
1799
+ * The base URL of the Segment API, when using a custom domain in Segment.
1800
+ */
769
1801
  host?: pulumi.Input<string>;
770
1802
  id?: pulumi.Input<string>;
1803
+ /**
1804
+ * A custom name for your connector.
1805
+ */
771
1806
  name: pulumi.Input<string>;
1807
+ /**
1808
+ * The Segment Write Key generated for the Descope service.
1809
+ */
772
1810
  writeKey: pulumi.Input<string>;
773
1811
  }
774
1812
  export interface ProjectConnectorsSendgrid {
775
1813
  authentication: pulumi.Input<inputs.ProjectConnectorsSendgridAuthentication>;
1814
+ /**
1815
+ * A description of what your connector is used for.
1816
+ */
776
1817
  description?: pulumi.Input<string>;
777
1818
  id?: pulumi.Input<string>;
1819
+ /**
1820
+ * A custom name for your connector.
1821
+ */
778
1822
  name: pulumi.Input<string>;
779
1823
  sender: pulumi.Input<inputs.ProjectConnectorsSendgridSender>;
780
1824
  }
@@ -787,8 +1831,14 @@ export interface ProjectConnectorsSendgridSender {
787
1831
  }
788
1832
  export interface ProjectConnectorsSmtp {
789
1833
  authentication: pulumi.Input<inputs.ProjectConnectorsSmtpAuthentication>;
1834
+ /**
1835
+ * A description of what your connector is used for.
1836
+ */
790
1837
  description?: pulumi.Input<string>;
791
1838
  id?: pulumi.Input<string>;
1839
+ /**
1840
+ * A custom name for your connector.
1841
+ */
792
1842
  name: pulumi.Input<string>;
793
1843
  sender: pulumi.Input<inputs.ProjectConnectorsSmtpSender>;
794
1844
  server: pulumi.Input<inputs.ProjectConnectorsSmtpServer>;
@@ -809,31 +1859,70 @@ export interface ProjectConnectorsSmtpServer {
809
1859
  export interface ProjectConnectorsSumologic {
810
1860
  auditEnabled?: pulumi.Input<boolean>;
811
1861
  auditFilters?: pulumi.Input<string>;
1862
+ /**
1863
+ * A description of what your connector is used for.
1864
+ */
812
1865
  description?: pulumi.Input<string>;
1866
+ /**
1867
+ * The URL associated with an HTTP Hosted collector
1868
+ */
813
1869
  httpSourceUrl: pulumi.Input<string>;
814
1870
  id?: pulumi.Input<string>;
1871
+ /**
1872
+ * A custom name for your connector.
1873
+ */
815
1874
  name: pulumi.Input<string>;
816
1875
  troubleshootLogEnabled?: pulumi.Input<boolean>;
817
1876
  }
818
1877
  export interface ProjectConnectorsTelesign {
1878
+ /**
1879
+ * The unique Telesign API key
1880
+ */
819
1881
  apiKey: pulumi.Input<string>;
1882
+ /**
1883
+ * The unique Telesign account Customer ID
1884
+ */
820
1885
  customerId: pulumi.Input<string>;
1886
+ /**
1887
+ * A description of what your connector is used for.
1888
+ */
821
1889
  description?: pulumi.Input<string>;
822
1890
  id?: pulumi.Input<string>;
1891
+ /**
1892
+ * A custom name for your connector.
1893
+ */
823
1894
  name: pulumi.Input<string>;
824
1895
  }
825
1896
  export interface ProjectConnectorsTraceable {
1897
+ /**
1898
+ * A description of what your connector is used for.
1899
+ */
826
1900
  description?: pulumi.Input<string>;
1901
+ /**
1902
+ * EU(Europe) Region deployment of Traceable platform.
1903
+ */
827
1904
  euRegion?: pulumi.Input<boolean>;
828
1905
  id?: pulumi.Input<string>;
1906
+ /**
1907
+ * A custom name for your connector.
1908
+ */
829
1909
  name: pulumi.Input<string>;
1910
+ /**
1911
+ * The Traceable secret key.
1912
+ */
830
1913
  secretKey: pulumi.Input<string>;
831
1914
  }
832
1915
  export interface ProjectConnectorsTwilioCore {
833
1916
  accountSid: pulumi.Input<string>;
834
1917
  authentication: pulumi.Input<inputs.ProjectConnectorsTwilioCoreAuthentication>;
1918
+ /**
1919
+ * A description of what your connector is used for.
1920
+ */
835
1921
  description?: pulumi.Input<string>;
836
1922
  id?: pulumi.Input<string>;
1923
+ /**
1924
+ * A custom name for your connector.
1925
+ */
837
1926
  name: pulumi.Input<string>;
838
1927
  senders: pulumi.Input<inputs.ProjectConnectorsTwilioCoreSenders>;
839
1928
  }
@@ -856,8 +1945,14 @@ export interface ProjectConnectorsTwilioCoreSendersVoice {
856
1945
  export interface ProjectConnectorsTwilioVerify {
857
1946
  accountSid: pulumi.Input<string>;
858
1947
  authentication: pulumi.Input<inputs.ProjectConnectorsTwilioVerifyAuthentication>;
1948
+ /**
1949
+ * A description of what your connector is used for.
1950
+ */
859
1951
  description?: pulumi.Input<string>;
860
1952
  id?: pulumi.Input<string>;
1953
+ /**
1954
+ * A custom name for your connector.
1955
+ */
861
1956
  name: pulumi.Input<string>;
862
1957
  sender?: pulumi.Input<string>;
863
1958
  serviceSid: pulumi.Input<string>;
@@ -868,11 +1963,26 @@ export interface ProjectConnectorsTwilioVerifyAuthentication {
868
1963
  authToken?: pulumi.Input<string>;
869
1964
  }
870
1965
  export interface ProjectConnectorsVeriff {
1966
+ /**
1967
+ * The Veriff Public API Key, you can find under Veriff Station - Integrations.
1968
+ */
871
1969
  apiKey: pulumi.Input<string>;
1970
+ /**
1971
+ * The base URL of the Veriff API, default value is https://stationapi.veriff.com.
1972
+ */
872
1973
  baseUrl?: pulumi.Input<string>;
1974
+ /**
1975
+ * A description of what your connector is used for.
1976
+ */
873
1977
  description?: pulumi.Input<string>;
874
1978
  id?: pulumi.Input<string>;
1979
+ /**
1980
+ * A custom name for your connector.
1981
+ */
875
1982
  name: pulumi.Input<string>;
1983
+ /**
1984
+ * The Veriff Shared secret key, you can find under Veriff Station - Integrations.
1985
+ */
876
1986
  secretKey: pulumi.Input<string>;
877
1987
  }
878
1988
  export interface ProjectFlows {
@@ -886,9 +1996,6 @@ export interface ProjectJwtTemplatesAccessKeyTemplate {
886
1996
  authSchema?: pulumi.Input<string>;
887
1997
  conformanceIssuer?: pulumi.Input<boolean>;
888
1998
  description?: pulumi.Input<string>;
889
- /**
890
- * The ID of this resource.
891
- */
892
1999
  id?: pulumi.Input<string>;
893
2000
  name: pulumi.Input<string>;
894
2001
  template: pulumi.Input<string>;
@@ -897,9 +2004,6 @@ export interface ProjectJwtTemplatesUserTemplate {
897
2004
  authSchema?: pulumi.Input<string>;
898
2005
  conformanceIssuer?: pulumi.Input<boolean>;
899
2006
  description?: pulumi.Input<string>;
900
- /**
901
- * The ID of this resource.
902
- */
903
2007
  id?: pulumi.Input<string>;
904
2008
  name: pulumi.Input<string>;
905
2009
  template: pulumi.Input<string>;