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