@descope/pulumi-descope 0.3.4 → 0.3.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/accessKey.d.ts +197 -0
  2. package/accessKey.d.ts.map +1 -0
  3. package/accessKey.js +105 -0
  4. package/accessKey.js.map +1 -0
  5. package/config/index.d.ts +1 -0
  6. package/config/index.d.ts.map +1 -0
  7. package/config/vars.d.ts +1 -0
  8. package/config/vars.d.ts.map +1 -0
  9. package/config/vars.js +24 -1
  10. package/config/vars.js.map +1 -1
  11. package/descoper.d.ts +178 -0
  12. package/descoper.d.ts.map +1 -0
  13. package/descoper.js +175 -0
  14. package/descoper.js.map +1 -0
  15. package/engine.d.ts +77 -0
  16. package/engine.d.ts.map +1 -0
  17. package/engine.js +83 -0
  18. package/engine.js.map +1 -0
  19. package/inboundApp.d.ts +255 -0
  20. package/inboundApp.d.ts.map +1 -0
  21. package/inboundApp.js +111 -0
  22. package/inboundApp.js.map +1 -0
  23. package/index.d.ts +16 -0
  24. package/index.d.ts.map +1 -0
  25. package/index.js +42 -5
  26. package/index.js.map +1 -1
  27. package/managementKey.d.ts +189 -0
  28. package/managementKey.d.ts.map +1 -0
  29. package/managementKey.js +159 -0
  30. package/managementKey.js.map +1 -0
  31. package/package.json +4 -4
  32. package/project.d.ts +309 -30
  33. package/project.d.ts.map +1 -0
  34. package/project.js +295 -4
  35. package/project.js.map +1 -1
  36. package/provider.d.ts +4 -3
  37. package/provider.d.ts.map +1 -0
  38. package/provider.js +27 -4
  39. package/provider.js.map +1 -1
  40. package/types/index.d.ts +1 -0
  41. package/types/index.d.ts.map +1 -0
  42. package/types/index.js +25 -2
  43. package/types/index.js.map +1 -1
  44. package/types/input.d.ts +2910 -887
  45. package/types/input.d.ts.map +1 -0
  46. package/types/output.d.ts +2199 -176
  47. package/types/output.d.ts.map +1 -0
  48. package/utilities.d.ts +1 -0
  49. package/utilities.d.ts.map +1 -0
  50. package/utilities.js +24 -1
  51. package/utilities.js.map +1 -1
package/types/output.d.ts CHANGED
@@ -1,4 +1,186 @@
1
1
  import * as outputs from "../types/output";
2
+ export interface AccessKeyTenant {
3
+ /**
4
+ * The roles the access key will be granted within the tenant.
5
+ */
6
+ roles: string[];
7
+ /**
8
+ * The ID of the tenant to associate with the access key.
9
+ */
10
+ tenantId: string;
11
+ }
12
+ export interface DescoperRbac {
13
+ /**
14
+ * Whether this descoper has company-wide admin access. When set to `true`, the descoper cannot have `tagRoles` or `projectRoles`.
15
+ */
16
+ isCompanyAdmin: boolean;
17
+ /**
18
+ * A list of roles that are granted to the descoper for specific projects by their project ID.
19
+ */
20
+ projectRoles: outputs.DescoperRbacProjectRole[];
21
+ /**
22
+ * A list of roles that are granted to the descoper for all projects that have a specific tag.
23
+ */
24
+ tagRoles: outputs.DescoperRbacTagRole[];
25
+ }
26
+ export interface DescoperRbacProjectRole {
27
+ /**
28
+ * The project IDs this role grant applies to.
29
+ */
30
+ projectIds: string[];
31
+ /**
32
+ * The roles the descoper will be granted in the applicable projects. Must be one of: `admin`, `developer`, `support`, `auditor`.
33
+ */
34
+ role: string;
35
+ }
36
+ export interface DescoperRbacTagRole {
37
+ /**
38
+ * The role the descoper will be granted in the applicable projects. Must be one of: `admin`, `developer`, `support`, `auditor`.
39
+ */
40
+ role: string;
41
+ /**
42
+ * The project tags this role assignment applies to.
43
+ */
44
+ tags: string[];
45
+ }
46
+ export interface InboundAppAttributesScope {
47
+ /**
48
+ * A description for the scope.
49
+ */
50
+ description: string;
51
+ /**
52
+ * A name for the scope.
53
+ */
54
+ name: string;
55
+ /**
56
+ * Whether this scope is optional. When `false`, the scope is mandatory and must be granted during authorization. When `true`, the user may choose to withhold it.
57
+ */
58
+ optional: boolean;
59
+ /**
60
+ * The identifiers of the relevant permission, attribute or connection scopes.
61
+ */
62
+ values: string[];
63
+ }
64
+ export interface InboundAppConnectionsScope {
65
+ /**
66
+ * A description for the scope.
67
+ */
68
+ description: string;
69
+ /**
70
+ * A name for the scope.
71
+ */
72
+ name: string;
73
+ /**
74
+ * Whether this scope is optional. When `false`, the scope is mandatory and must be granted during authorization. When `true`, the user may choose to withhold it.
75
+ */
76
+ optional: boolean;
77
+ /**
78
+ * The identifiers of the relevant permission, attribute or connection scopes.
79
+ */
80
+ values: string[];
81
+ }
82
+ export interface InboundAppPermissionsScope {
83
+ /**
84
+ * A description for the scope.
85
+ */
86
+ description: string;
87
+ /**
88
+ * A name for the scope.
89
+ */
90
+ name: string;
91
+ /**
92
+ * Whether this scope is optional. When `false`, the scope is mandatory and must be granted during authorization. When `true`, the user may choose to withhold it.
93
+ */
94
+ optional: boolean;
95
+ /**
96
+ * The identifiers of the relevant permission, attribute or connection scopes.
97
+ */
98
+ values: string[];
99
+ }
100
+ export interface InboundAppSessionSettings {
101
+ /**
102
+ * Whether to override the project's session settings.
103
+ */
104
+ enabled: boolean;
105
+ /**
106
+ * The expiration duration for access key session tokens. Must be between 3 minutes and one month.
107
+ */
108
+ keySessionTokenExpiration: string;
109
+ /**
110
+ * The ID of the JWT template to use for access key JWTs issued to this inbound app.
111
+ */
112
+ keyTemplateId: string;
113
+ /**
114
+ * The expiration duration for refresh tokens issued to this inbound app.
115
+ */
116
+ refreshTokenExpiration: string;
117
+ /**
118
+ * The expiration duration for session tokens issued to this inbound app.
119
+ */
120
+ sessionTokenExpiration: string;
121
+ /**
122
+ * The ID of the JWT template to use for user JWTs issued to this inbound app.
123
+ */
124
+ userTemplateId: string;
125
+ }
126
+ export interface ManagementKeyRebac {
127
+ /**
128
+ * A list of company-level role names that are granted to the management key. This attribute is mutually exclusive with `tagRoles` and `projectRoles`.
129
+ */
130
+ companyRoles: string[];
131
+ /**
132
+ * A list of project-level role names that are granted to the management key for specific projects by their project ID.
133
+ */
134
+ projectRoles: outputs.ManagementKeyRebacProjectRole[];
135
+ /**
136
+ * A list of project-level role names that are granted to the management key for all projects that have a specific tag.
137
+ */
138
+ tagRoles: outputs.ManagementKeyRebacTagRole[];
139
+ }
140
+ export interface ManagementKeyRebacProjectRole {
141
+ /**
142
+ * The project IDs this role grant applies to.
143
+ */
144
+ projectIds: string[];
145
+ /**
146
+ * The roles the management key will be granted in the applicable projects.
147
+ */
148
+ roles: string[];
149
+ }
150
+ export interface ManagementKeyRebacTagRole {
151
+ /**
152
+ * The roles the management key will be granted in the applicable projects.
153
+ */
154
+ roles: string[];
155
+ /**
156
+ * The project tags this role grant applies to.
157
+ */
158
+ tags: string[];
159
+ }
160
+ export interface ProjectAdminPortal {
161
+ /**
162
+ * Whether the Admin Portal is enabled
163
+ */
164
+ enabled: boolean;
165
+ /**
166
+ * The style id to use
167
+ */
168
+ styleId: string;
169
+ /**
170
+ * The widgets to show in the Admin Portal
171
+ */
172
+ widgets: outputs.ProjectAdminPortalWidget[];
173
+ }
174
+ export interface ProjectAdminPortalWidget {
175
+ /**
176
+ * The type of the Widget
177
+ */
178
+ type: string;
179
+ /**
180
+ * The unique identifier of the Widget
181
+ */
182
+ widgetId: string;
183
+ }
2
184
  export interface ProjectApplications {
3
185
  /**
4
186
  * Applications using OpenID Connect (OIDC) for authentication.
@@ -8,16 +190,60 @@ export interface ProjectApplications {
8
190
  * Applications using SAML for authentication.
9
191
  */
10
192
  samlApplications: outputs.ProjectApplicationsSamlApplication[];
193
+ /**
194
+ * Applications using WS-Federation for authentication.
195
+ */
196
+ wsfedApplications: outputs.ProjectApplicationsWsfedApplication[];
11
197
  }
12
198
  export interface ProjectApplicationsOidcApplication {
199
+ /**
200
+ * A list of approved redirect URLs for this application (supports `*` wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains.
201
+ */
202
+ approvedRedirectUrls: string[];
203
+ /**
204
+ * Disables the `authorizationCode` grant type for this application.
205
+ */
206
+ authorizationCodeDisabled: boolean;
207
+ /**
208
+ * The URL that Descope notifies with a logout token when the user's session ends, as per the [OIDC Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html) specification. Leave empty to disable back-channel logout notifications for this application.
209
+ */
210
+ backchannelLogoutUrl: string;
13
211
  /**
14
212
  * A list of supported claims. e.g. `sub`, `email`, `exp`.
15
213
  */
16
214
  claims: string[];
215
+ /**
216
+ * Disables the `clientCredentials` grant type for this application.
217
+ */
218
+ clientCredentialsDisabled: boolean;
219
+ /**
220
+ * A dedicated OIDC `clientId` to import for this application. When omitted, the `clientId` is computed by the server; when set, it must be unique within the project. Can only be set when the application is created, and attempting to change it on an existing application will fail.
221
+ */
222
+ clientId: string;
223
+ /**
224
+ * A dedicated OIDC `clientSecret` to import for this application, applied on creation only. When omitted, a secret is generated server-side. The value is sensitive and is not returned on subsequent reads.
225
+ */
226
+ clientSecret: string;
227
+ /**
228
+ * OAuth client confidentiality. One of `""` (default — legacy access-key authentication), `"confidential"` (a dedicated client secret is generated for the app), or `"public"`.
229
+ */
230
+ clientType: string;
231
+ /**
232
+ * A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
233
+ */
234
+ customIdpInitiatedLoginPageUrl: string;
235
+ /**
236
+ * Controls the default `aud` claim of tokens issued for this application. One of `"projectId"` (the project ID only), `"clientId"` (the dedicated client ID only), `"appId"` (the application ID only), `"empty"` (no `aud` claim at all), or `""` (default — both the project ID and the client ID). Only applies to modern apps that set a `clientType`; legacy apps always use the project ID, so the empty default leaves their behavior unchanged.
237
+ */
238
+ defaultAudience: string;
17
239
  /**
18
240
  * A description for the OIDC application.
19
241
  */
20
242
  description: string;
243
+ /**
244
+ * Disables the `urn:ietf:params:oauth:grant-type:device_code` grant type for this application.
245
+ */
246
+ deviceCodeDisabled: boolean;
21
247
  /**
22
248
  * Whether the application should be enabled or disabled.
23
249
  */
@@ -26,10 +252,18 @@ export interface ProjectApplicationsOidcApplication {
26
252
  * This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
27
253
  */
28
254
  forceAuthentication: boolean;
255
+ /**
256
+ * When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE `codeVerifier`. Public clients always use PKCE regardless of this setting.
257
+ */
258
+ forcePkce: boolean;
29
259
  /**
30
260
  * An optional identifier for the OIDC application.
31
261
  */
32
262
  id: string;
263
+ /**
264
+ * Disables the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant type for this application.
265
+ */
266
+ jwtBearerDisabled: boolean;
33
267
  /**
34
268
  * The Flow Hosting URL. Read more about using this parameter with custom domain [here](https://docs.descope.com/sso-integrations/applications/saml-apps).
35
269
  */
@@ -42,6 +276,28 @@ export interface ProjectApplicationsOidcApplication {
42
276
  * A name for the OIDC application.
43
277
  */
44
278
  name: string;
279
+ permissions: outputs.ProjectApplicationsOidcApplicationPermission[];
280
+ /**
281
+ * Disables the `refreshToken` grant type for this application.
282
+ */
283
+ refreshTokenDisabled: boolean;
284
+ roles: outputs.ProjectApplicationsOidcApplicationRole[];
285
+ /**
286
+ * Controls the audience values appended to the issued token's `aud` claim for trusted sibling applications. One of `"projectId"`, `"clientId"`, `"appId"`, `"empty"` (add none), or `""` (default — both the project ID and the client ID). Independent of `defaultAudience`.
287
+ */
288
+ trustedAppsAudience: string;
289
+ }
290
+ export interface ProjectApplicationsOidcApplicationPermission {
291
+ description: string;
292
+ id: string;
293
+ name: string;
294
+ }
295
+ export interface ProjectApplicationsOidcApplicationRole {
296
+ description: string;
297
+ id: string;
298
+ name: string;
299
+ permissions: string[];
300
+ roleMappings: string[];
45
301
  }
46
302
  export interface ProjectApplicationsSamlApplication {
47
303
  /**
@@ -56,6 +312,10 @@ export interface ProjectApplicationsSamlApplication {
56
312
  * The default relay state. When using IdP-initiated authentication, this value may be used as a URL to a resource in the Service Provider.
57
313
  */
58
314
  defaultRelayState: string;
315
+ /**
316
+ * The signature algorithm used to sign SAML responses. Choose one of `""` (default, SHA-1) or `"sha256"` (SHA-256). Only applies to IdP-initiated flows — SP-initiated flows use the algorithm specified in the SP's SAML request.
317
+ */
318
+ defaultSignatureAlgorithm: string;
59
319
  /**
60
320
  * A description for the SAML application.
61
321
  */
@@ -92,6 +352,8 @@ export interface ProjectApplicationsSamlApplication {
92
352
  * A name for the SAML application.
93
353
  */
94
354
  name: string;
355
+ permissions: outputs.ProjectApplicationsSamlApplicationPermission[];
356
+ roles: outputs.ProjectApplicationsSamlApplicationRole[];
95
357
  /**
96
358
  * The subject name id format. Choose one of "", "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", "urn:oasis:names:tc:SAML:2.0:nameid-format:transient". Read more about this configuration [here](https://docs.descope.com/sso-integrations/applications/saml-apps).
97
359
  */
@@ -131,129 +393,291 @@ export interface ProjectApplicationsSamlApplicationManualConfiguration {
131
393
  */
132
394
  entityId: string;
133
395
  }
134
- export interface ProjectAttributes {
396
+ export interface ProjectApplicationsSamlApplicationPermission {
397
+ description: string;
398
+ id: string;
399
+ name: string;
400
+ }
401
+ export interface ProjectApplicationsSamlApplicationRole {
402
+ description: string;
403
+ id: string;
404
+ name: string;
405
+ permissions: string[];
406
+ roleMappings: string[];
407
+ }
408
+ export interface ProjectApplicationsWsfedApplication {
135
409
  /**
136
- * A list of `TenantAttribute`. Read the description below.
410
+ * A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
137
411
  */
138
- tenants: outputs.ProjectAttributesTenant[];
412
+ attributeMappings: outputs.ProjectApplicationsWsfedApplicationAttributeMapping[];
139
413
  /**
140
- * A list of `UserAttribute`. Read the description below.
414
+ * A description for the WS-Fed application.
141
415
  */
142
- users: outputs.ProjectAttributesUser[];
143
- }
144
- export interface ProjectAttributesTenant {
416
+ description: string;
145
417
  /**
146
- * Determines the required permissions for this tenant.
418
+ * Whether the application should be enabled or disabled.
147
419
  */
148
- authorization: outputs.ProjectAttributesTenantAuthorization;
420
+ disabled: boolean;
149
421
  /**
150
- * An optional identifier for the attribute. This value is called `Machine Name` in the Descope console. If a value is not provided then an appropriate one will be created from the value of `name`.
422
+ * The URL to redirect to when an error occurs.
151
423
  */
152
- id: string;
424
+ errorRedirectUrl: string;
153
425
  /**
154
- * The name of the attribute. This value is called `Display Name` in the Descope console.
426
+ * This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
155
427
  */
156
- name: string;
428
+ forceAuthentication: boolean;
157
429
  /**
158
- * When the attribute type is "multiselect". A list of options to choose from.
430
+ * A list of group mappings from Descope roles to WS-Fed groups.
159
431
  */
160
- selectOptions: string[];
432
+ groupsMappings: outputs.ProjectApplicationsWsfedApplicationGroupsMapping[];
161
433
  /**
162
- * The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
434
+ * An optional identifier for the WS-Fed application.
163
435
  */
164
- type: string;
165
- }
166
- export interface ProjectAttributesTenantAuthorization {
436
+ id: string;
167
437
  /**
168
- * Determines the required permissions for this tenant.
438
+ * The Flow Hosting URL.
169
439
  */
170
- viewPermissions: string[];
171
- }
172
- export interface ProjectAttributesUser {
440
+ loginPageUrl: string;
173
441
  /**
174
- * An optional identifier for the attribute. This value is called `Machine Name` in the Descope console. If a value is not provided then an appropriate one will be created from the value of `name`.
442
+ * A logo for the WS-Fed application. Should be a hosted image URL.
175
443
  */
176
- id: string;
444
+ logo: string;
177
445
  /**
178
- * The name of the attribute. This value is called `Display Name` in the Descope console.
446
+ * The URL to redirect to after logout.
447
+ */
448
+ logoutRedirectUrl: string;
449
+ /**
450
+ * A name for the WS-Fed application.
179
451
  */
180
452
  name: string;
453
+ permissions: outputs.ProjectApplicationsWsfedApplicationPermission[];
181
454
  /**
182
- * When the attribute type is "multiselect". A list of options to choose from.
455
+ * The WS-Fed realm identifier for the application.
183
456
  */
184
- selectOptions: string[];
457
+ realm: string;
185
458
  /**
186
- * The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
459
+ * Additional allowed `wreply` callback URLs beyond `replyUrl`. Each entry may include the `*` wildcard. When the RP supplies a `wreply` parameter, it must match either the default `replyUrl` or one of these patterns.
187
460
  */
188
- type: string;
461
+ replyAllowedCallbackUrls: string[];
189
462
  /**
190
- * Determines the permissions users are required to have to access this attribute in the user management widget.
463
+ * The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no `wreply` is supplied by the RP.
191
464
  */
192
- widgetAuthorization: outputs.ProjectAttributesUserWidgetAuthorization;
465
+ replyUrl: string;
466
+ roles: outputs.ProjectApplicationsWsfedApplicationRole[];
193
467
  }
194
- export interface ProjectAttributesUserWidgetAuthorization {
468
+ export interface ProjectApplicationsWsfedApplicationAttributeMapping {
195
469
  /**
196
- * The permissions users are required to have to edit this attribute in the user management widget.
470
+ * The name of the attribute.
197
471
  */
198
- editPermissions: string[];
472
+ name: string;
199
473
  /**
200
- * The permissions users are required to have to view this attribute in the user management widget.
474
+ * The value of the attribute.
201
475
  */
202
- viewPermissions: string[];
476
+ value: string;
203
477
  }
204
- export interface ProjectAuthentication {
205
- /**
206
- * 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.
207
- */
208
- embeddedLink: outputs.ProjectAuthenticationEmbeddedLink;
478
+ export interface ProjectApplicationsWsfedApplicationGroupsMapping {
209
479
  /**
210
- * 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.
480
+ * The filter type for the groups mapping.
211
481
  */
212
- enchantedLink: outputs.ProjectAuthenticationEnchantedLink;
482
+ filterType: string;
213
483
  /**
214
- * An authentication method where a user receives a unique link via email to log in.
484
+ * The name of the groups mapping.
215
485
  */
216
- magicLink: outputs.ProjectAuthenticationMagicLink;
486
+ name: string;
217
487
  /**
218
- * Authentication using Open Authorization, which allows users to authenticate with various external services.
488
+ * The `RoleGroupMapping` object. A list of roles mapped to this group.
219
489
  */
220
- oauth: outputs.ProjectAuthenticationOauth;
490
+ roles: outputs.ProjectApplicationsWsfedApplicationGroupsMappingRole[];
221
491
  /**
222
- * A dynamically generated set of numbers, granting the user one-time access.
492
+ * The type of the groups mapping.
223
493
  */
224
- otp: outputs.ProjectAuthenticationOtp;
494
+ type: string;
225
495
  /**
226
- * Device-based passwordless authentication, using fingerprint, face scan, and more.
496
+ * The value of the groups mapping.
227
497
  */
228
- passkeys: outputs.ProjectAuthenticationPasskeys;
498
+ value: string;
499
+ }
500
+ export interface ProjectApplicationsWsfedApplicationGroupsMappingRole {
229
501
  /**
230
- * The classic username and password combination used for authentication.
502
+ * The identifier of the role.
231
503
  */
232
- password: outputs.ProjectAuthenticationPassword;
504
+ id: string;
233
505
  /**
234
- * Single Sign-On (SSO) authentication method that enables users to access multiple applications with a single set of credentials.
506
+ * The name of the role.
235
507
  */
236
- sso: outputs.ProjectAuthenticationSso;
508
+ name: string;
509
+ }
510
+ export interface ProjectApplicationsWsfedApplicationPermission {
511
+ description: string;
512
+ id: string;
513
+ name: string;
514
+ }
515
+ export interface ProjectApplicationsWsfedApplicationRole {
516
+ description: string;
517
+ id: string;
518
+ name: string;
519
+ permissions: string[];
520
+ roleMappings: string[];
521
+ }
522
+ export interface ProjectAttributes {
237
523
  /**
238
- * A one-time code generated for the user using a shared secret and time.
524
+ * A list of custom attributes for storing additional details about each access key in the project.
239
525
  */
240
- totp: outputs.ProjectAuthenticationTotp;
241
- }
242
- export interface ProjectAuthenticationEmbeddedLink {
526
+ accessKeys: outputs.ProjectAttributesAccessKey[];
243
527
  /**
244
- * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
528
+ * A list of custom attributes for storing additional details about each tenant in the project.
245
529
  */
246
- disabled: boolean;
530
+ tenants: outputs.ProjectAttributesTenant[];
247
531
  /**
248
- * How long the embedded link remains valid before it expires.
532
+ * A list of custom attributes for storing additional details about each user in the project.
249
533
  */
250
- expirationTime: string;
534
+ users: outputs.ProjectAttributesUser[];
251
535
  }
252
- export interface ProjectAuthenticationEnchantedLink {
536
+ export interface ProjectAttributesAccessKey {
253
537
  /**
254
- * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
538
+ * An optional identifier for the attribute. This value is called `Machine Name` in the Descope console. If a value is not provided then an appropriate one will be created from the value of `name`.
255
539
  */
256
- disabled: boolean;
540
+ id: string;
541
+ /**
542
+ * The name of the attribute. This value is called `Display Name` in the Descope console.
543
+ */
544
+ name: string;
545
+ /**
546
+ * When the attribute type is "multiselect". A list of options to choose from.
547
+ */
548
+ selectOptions: string[];
549
+ /**
550
+ * The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
551
+ */
552
+ type: string;
553
+ /**
554
+ * Determines the permissions access key are required to have to access this attribute in the access key management widget.
555
+ */
556
+ widgetAuthorization: outputs.ProjectAttributesAccessKeyWidgetAuthorization;
557
+ }
558
+ export interface ProjectAttributesAccessKeyWidgetAuthorization {
559
+ /**
560
+ * The permissions users are required to have to edit this attribute in the access key management widget.
561
+ */
562
+ editPermissions: string[];
563
+ /**
564
+ * The permissions users are required to have to view this attribute in the access key management widget.
565
+ */
566
+ viewPermissions: string[];
567
+ }
568
+ export interface ProjectAttributesTenant {
569
+ /**
570
+ * Determines the required permissions for this tenant.
571
+ */
572
+ authorization: outputs.ProjectAttributesTenantAuthorization;
573
+ /**
574
+ * An optional identifier for the attribute. This value is called `Machine Name` in the Descope console. If a value is not provided then an appropriate one will be created from the value of `name`.
575
+ */
576
+ id: string;
577
+ /**
578
+ * The name of the attribute. This value is called `Display Name` in the Descope console.
579
+ */
580
+ name: string;
581
+ /**
582
+ * When the attribute type is "multiselect". A list of options to choose from.
583
+ */
584
+ selectOptions: string[];
585
+ /**
586
+ * The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
587
+ */
588
+ type: string;
589
+ }
590
+ export interface ProjectAttributesTenantAuthorization {
591
+ /**
592
+ * Determines the required permissions for this tenant.
593
+ */
594
+ viewPermissions: string[];
595
+ }
596
+ export interface ProjectAttributesUser {
597
+ /**
598
+ * An optional identifier for the attribute. This value is called `Machine Name` in the Descope console. If a value is not provided then an appropriate one will be created from the value of `name`.
599
+ */
600
+ id: string;
601
+ /**
602
+ * The name of the attribute. This value is called `Display Name` in the Descope console.
603
+ */
604
+ name: string;
605
+ /**
606
+ * When the attribute type is "multiselect". A list of options to choose from.
607
+ */
608
+ selectOptions: string[];
609
+ /**
610
+ * The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
611
+ */
612
+ type: string;
613
+ /**
614
+ * Determines the permissions users are required to have to access this attribute in the user management widget.
615
+ */
616
+ widgetAuthorization: outputs.ProjectAttributesUserWidgetAuthorization;
617
+ }
618
+ export interface ProjectAttributesUserWidgetAuthorization {
619
+ /**
620
+ * The permissions users are required to have to edit this attribute in the user management widget.
621
+ */
622
+ editPermissions: string[];
623
+ /**
624
+ * The permissions users are required to have to view this attribute in the user management widget.
625
+ */
626
+ viewPermissions: string[];
627
+ }
628
+ export interface ProjectAuthentication {
629
+ /**
630
+ * 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.
631
+ */
632
+ embeddedLink: outputs.ProjectAuthenticationEmbeddedLink;
633
+ /**
634
+ * 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.
635
+ */
636
+ enchantedLink: outputs.ProjectAuthenticationEnchantedLink;
637
+ /**
638
+ * An authentication method where a user receives a unique link via email to log in.
639
+ */
640
+ magicLink: outputs.ProjectAuthenticationMagicLink;
641
+ /**
642
+ * Authentication using Open Authorization, which allows users to authenticate with various external services.
643
+ */
644
+ oauth: outputs.ProjectAuthenticationOauth;
645
+ /**
646
+ * A dynamically generated set of numbers, granting the user one-time access.
647
+ */
648
+ otp: outputs.ProjectAuthenticationOtp;
649
+ /**
650
+ * Device-based passwordless authentication, using fingerprint, face scan, and more.
651
+ */
652
+ passkeys: outputs.ProjectAuthenticationPasskeys;
653
+ /**
654
+ * The classic username and password combination used for authentication.
655
+ */
656
+ password: outputs.ProjectAuthenticationPassword;
657
+ /**
658
+ * Single Sign-On (SSO) authentication method that enables users to access multiple applications with a single set of credentials.
659
+ */
660
+ sso: outputs.ProjectAuthenticationSso;
661
+ /**
662
+ * A one-time code generated for the user using a shared secret and time.
663
+ */
664
+ totp: outputs.ProjectAuthenticationTotp;
665
+ }
666
+ export interface ProjectAuthenticationEmbeddedLink {
667
+ /**
668
+ * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
669
+ */
670
+ disabled: boolean;
671
+ /**
672
+ * How long the embedded link remains valid before it expires.
673
+ */
674
+ expirationTime: string;
675
+ }
676
+ export interface ProjectAuthenticationEnchantedLink {
677
+ /**
678
+ * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
679
+ */
680
+ disabled: boolean;
257
681
  /**
258
682
  * Settings related to sending emails as part of the enchanted link authentication.
259
683
  */
@@ -1896,24 +2320,48 @@ export interface ProjectAuthenticationOtpVoiceServiceTemplate {
1896
2320
  name: string;
1897
2321
  }
1898
2322
  export interface ProjectAuthenticationPasskeys {
2323
+ /**
2324
+ * A list of SHA-256 APK key hash fingerprints (colon-separated hex, e.g. `AB:CD:EF:...`) that are allowed as passkey origins for Android apps. When set, only Android apps with a matching fingerprint will be permitted to use passkey authentication.
2325
+ */
2326
+ androidFingerprints: string[];
1899
2327
  /**
1900
2328
  * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
1901
2329
  */
1902
2330
  disabled: boolean;
2331
+ /**
2332
+ * The human-friendly name shown to users when they create or use a passkey. Some password managers display this name, while others display the top level domain instead. When left empty, the project name is used.
2333
+ */
2334
+ displayName: string;
1903
2335
  /**
1904
2336
  * Passkeys will be usable in the following domain and all its subdomains.
1905
2337
  */
1906
2338
  topLevelDomain: string;
1907
2339
  }
1908
2340
  export interface ProjectAuthenticationPassword {
2341
+ /**
2342
+ * Whether passwords must contain at least one letter, either uppercase or lowercase.
2343
+ */
2344
+ anyLetter: boolean;
1909
2345
  /**
1910
2346
  * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
1911
2347
  */
1912
2348
  disabled: boolean;
2349
+ /**
2350
+ * Whether to reject passwords that match the user's email address or its local-part (the segment before `@`), case-insensitively. The check is skipped if the user's email is not known at validation time.
2351
+ */
2352
+ disallowEmailMatch: boolean;
2353
+ /**
2354
+ * Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., `"'"` to reject single and double quotes).
2355
+ */
2356
+ disallowedCharacters: string;
1913
2357
  /**
1914
2358
  * Settings related to sending password reset emails as part of the password feature.
1915
2359
  */
1916
2360
  emailService: outputs.ProjectAuthenticationPasswordEmailService;
2361
+ /**
2362
+ * Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
2363
+ */
2364
+ enforceStrength: string;
1917
2365
  /**
1918
2366
  * Whether users are required to change their password periodically.
1919
2367
  */
@@ -2021,10 +2469,34 @@ export interface ProjectAuthenticationSso {
2021
2469
  * Whether to allow overriding user's roles with SSO related roles.
2022
2470
  */
2023
2471
  allowOverrideRoles: boolean;
2472
+ /**
2473
+ * Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
2474
+ */
2475
+ blockIfEmailDomainMismatch: boolean;
2024
2476
  /**
2025
2477
  * Setting this to `true` will disallow using this authentication method directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use this authentication method.
2026
2478
  */
2027
2479
  disabled: boolean;
2480
+ /**
2481
+ * Settings related to sending SSO invite emails as part of the SSO feature.
2482
+ */
2483
+ emailService: outputs.ProjectAuthenticationSsoEmailService;
2484
+ /**
2485
+ * Whether to enable groups priority.
2486
+ */
2487
+ groupsPriority: boolean;
2488
+ /**
2489
+ * Mapping to attributes not specified in `mandatoryUserAttributes` is not allowed.
2490
+ */
2491
+ limitMappingToMandatoryAttributes: boolean;
2492
+ /**
2493
+ * Define the required Descope attributes that must be populated when receiving SSO information.
2494
+ */
2495
+ mandatoryUserAttributes: outputs.ProjectAuthenticationSsoMandatoryUserAttribute[];
2496
+ /**
2497
+ * Whether to mark the user's email as unverified when logging in via SSO.
2498
+ */
2499
+ markEmailAsUnverified: boolean;
2028
2500
  /**
2029
2501
  * Whether to merge existing user accounts with new ones created through SSO authentication.
2030
2502
  */
@@ -2033,11 +2505,66 @@ export interface ProjectAuthenticationSso {
2033
2505
  * The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
2034
2506
  */
2035
2507
  redirectUrl: string;
2508
+ /**
2509
+ * When configuring SSO the groups attribute name must be specified.
2510
+ */
2511
+ requireGroupsAttributeName: boolean;
2512
+ /**
2513
+ * When configuring SSO an SSO domain must be specified.
2514
+ */
2515
+ requireSsoDomains: boolean;
2036
2516
  /**
2037
2517
  * Configuration block for the SSO Suite.
2038
2518
  */
2039
2519
  ssoSuiteSettings: outputs.ProjectAuthenticationSsoSsoSuiteSettings;
2040
2520
  }
2521
+ export interface ProjectAuthenticationSsoEmailService {
2522
+ /**
2523
+ * The name of the email connector to use for sending emails.
2524
+ */
2525
+ connector: string;
2526
+ /**
2527
+ * A list of email templates for different authentication flows.
2528
+ */
2529
+ templates: outputs.ProjectAuthenticationSsoEmailServiceTemplate[];
2530
+ }
2531
+ export interface ProjectAuthenticationSsoEmailServiceTemplate {
2532
+ /**
2533
+ * Whether this email template is currently active and in use.
2534
+ */
2535
+ active: boolean;
2536
+ /**
2537
+ * HTML content of the email message body, required if `usePlainTextBody` isn't set.
2538
+ */
2539
+ htmlBody: string;
2540
+ id: string;
2541
+ /**
2542
+ * Unique name for this email template.
2543
+ */
2544
+ name: string;
2545
+ /**
2546
+ * Plain text version of the email message body, required if `usePlainTextBody` is set to `true`.
2547
+ */
2548
+ plainTextBody: string;
2549
+ /**
2550
+ * Subject line of the email message.
2551
+ */
2552
+ subject: string;
2553
+ /**
2554
+ * Whether to use the plain text body instead of HTML for the email.
2555
+ */
2556
+ usePlainTextBody: boolean;
2557
+ }
2558
+ export interface ProjectAuthenticationSsoMandatoryUserAttribute {
2559
+ /**
2560
+ * Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
2561
+ */
2562
+ custom: boolean;
2563
+ /**
2564
+ * The identifier for the attribute. This value is called `Machine Name` in the Descope console.
2565
+ */
2566
+ id: string;
2567
+ }
2041
2568
  export interface ProjectAuthenticationSsoSsoSuiteSettings {
2042
2569
  /**
2043
2570
  * Setting this to `true` will allow only verified domains to be used.
@@ -2047,14 +2574,26 @@ export interface ProjectAuthenticationSsoSsoSuiteSettings {
2047
2574
  * Setting this to `true` will hide the domains configuration section in the SSO Suite interface.
2048
2575
  */
2049
2576
  hideDomains: boolean;
2577
+ /**
2578
+ * Setting this to `true` will hide the FGA mapping configuration section in the SSO Suite interface.
2579
+ */
2580
+ hideFgaMapping: boolean;
2050
2581
  /**
2051
2582
  * Setting this to `true` will hide the groups mapping configuration section in the SSO Suite interface.
2052
2583
  */
2053
2584
  hideGroupsMapping: boolean;
2585
+ /**
2586
+ * Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
2587
+ */
2588
+ hideJitGuide: boolean;
2054
2589
  /**
2055
2590
  * Setting this to `true` will hide the OIDC configuration option.
2056
2591
  */
2057
2592
  hideOidc: boolean;
2593
+ /**
2594
+ * Setting this to `true` will hide the role mapping configuration section in the SSO Suite interface.
2595
+ */
2596
+ hideRoleMapping: boolean;
2058
2597
  /**
2059
2598
  * Setting this to `true` will hide the SAML configuration option.
2060
2599
  */
@@ -2063,10 +2602,18 @@ export interface ProjectAuthenticationSsoSsoSuiteSettings {
2063
2602
  * Setting this to `true` will hide the SCIM configuration in the SSO Suite interface.
2064
2603
  */
2065
2604
  hideScim: boolean;
2605
+ /**
2606
+ * Whether to display the help/support contact link in the SSO Suite UI.
2607
+ */
2608
+ showHelpContact: boolean;
2066
2609
  /**
2067
2610
  * Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
2068
2611
  */
2069
2612
  styleId: string;
2613
+ /**
2614
+ * Email address shown to end-users in the SSO Suite UI as a support contact.
2615
+ */
2616
+ supportEmail: string;
2070
2617
  }
2071
2618
  export interface ProjectAuthenticationTotp {
2072
2619
  /**
@@ -2079,6 +2626,10 @@ export interface ProjectAuthenticationTotp {
2079
2626
  serviceLabel: string;
2080
2627
  }
2081
2628
  export interface ProjectAuthorization {
2629
+ /**
2630
+ * The project's FGA schema, configured in the [Descope console](https://app.descope.com/authorization/fga) under the FGA tab. Use the code view to get the schema text and paste it as the value for this attribute.
2631
+ */
2632
+ fga: string;
2082
2633
  /**
2083
2634
  * A list of `Permission` objects.
2084
2635
  */
@@ -2109,6 +2660,9 @@ export interface ProjectAuthorizationRole {
2109
2660
  */
2110
2661
  description: string;
2111
2662
  id: string;
2663
+ /**
2664
+ * A persistent value that identifies a role uniquely across plan changes and configuration updates. It is used exclusively by the Terraform provider during planning, to ensure that user roles are maintained consistently even when role names or other details are changed. Once the `key` is set it should never be changed, otherwise the role will be removed and a new one will be created instead.
2665
+ */
2112
2666
  key: string;
2113
2667
  /**
2114
2668
  * A name for the role.
@@ -2128,10 +2682,18 @@ export interface ProjectConnectors {
2128
2682
  * Utilize IP threat intelligence to block malicious login attempts with the AbuseIPDB connector.
2129
2683
  */
2130
2684
  abuseipdbs: outputs.ProjectConnectorsAbuseipdb[];
2685
+ /**
2686
+ * Streamline identity verification and fraud monitoring with the Alloy connector.
2687
+ */
2688
+ alloys: outputs.ProjectConnectorsAlloy[];
2131
2689
  /**
2132
2690
  * Track user activity and traits at any point in your user journey with the Amplitude connector.
2133
2691
  */
2134
2692
  amplitudes: outputs.ProjectConnectorsAmplitude[];
2693
+ /**
2694
+ * Use the Arkose connector to integrate with Arkose's bot and fraud detection.
2695
+ */
2696
+ arkoses: outputs.ProjectConnectorsArkose[];
2135
2697
  /**
2136
2698
  * Send audit events to a custom webhook.
2137
2699
  */
@@ -2140,6 +2702,10 @@ export interface ProjectConnectors {
2140
2702
  * Stream authentication audit logs with the Amazon S3 connector.
2141
2703
  */
2142
2704
  awsS3s: outputs.ProjectConnectorsAwsS3[];
2705
+ /**
2706
+ * Validate email addresses using the AWS SES Email Validation API to check syntax, DNS records, mailbox existence, and deliverability.
2707
+ */
2708
+ awsSesEmailValidations: outputs.ProjectConnectorsAwsSesEmailValidation[];
2143
2709
  /**
2144
2710
  * Localize the language of your login and user journey screens with the Amazon Translate connector.
2145
2711
  */
@@ -2148,6 +2714,18 @@ export interface ProjectConnectors {
2148
2714
  * Utilize threat intelligence to block malicious login attempts or check leaks with the Bitsight Threat Intelligence connector.
2149
2715
  */
2150
2716
  bitsights: outputs.ProjectConnectorsBitsight[];
2717
+ /**
2718
+ * Send audit events and troubleshooting logs to Coralogix.
2719
+ */
2720
+ coralogixes: outputs.ProjectConnectorsCoralogix[];
2721
+ /**
2722
+ * Stream audit events and troubleshooting logs to Cribl Stream via the HTTP/S Bulk API. Requires an HTTP source configured in your Cribl deployment. See Cribl's HTTP/S source setup guide: https://docs.cribl.io/stream/sources-https/
2723
+ */
2724
+ cribls: outputs.ProjectConnectorsCribl[];
2725
+ /**
2726
+ * Connect to Darwinium API for fraud detection and device intelligence.
2727
+ */
2728
+ darwinia: outputs.ProjectConnectorsDarwinium[];
2151
2729
  /**
2152
2730
  * Stream authentication audit logs with the Datadog connector.
2153
2731
  */
@@ -2212,6 +2790,14 @@ export interface ProjectConnectors {
2212
2790
  * Get address autocompletions from Place Autocomplete Data API.
2213
2791
  */
2214
2792
  googleMapsPlaces: outputs.ProjectConnectorsGoogleMapsPlace[];
2793
+ /**
2794
+ * Send audit events and troubleshooting logs to groundcover.
2795
+ */
2796
+ groundcovers: outputs.ProjectConnectorsGroundcover[];
2797
+ /**
2798
+ * hCaptcha can help protect your applications from bots, spam, and other forms of automated abuse.
2799
+ */
2800
+ hcaptchas: outputs.ProjectConnectorsHcaptcha[];
2215
2801
  /**
2216
2802
  * Check if passwords have been previously exposed in data breaches with the Have I Been Pwned connector.
2217
2803
  */
@@ -2232,10 +2818,18 @@ export interface ProjectConnectors {
2232
2818
  * Orchestrate customer identity information from your Descope user journey with the Intercom connector.
2233
2819
  */
2234
2820
  intercoms: outputs.ProjectConnectorsIntercom[];
2821
+ /**
2822
+ * Use this connector to authenticate users against an LDAP directory server with support for both password and mTLS authentication.
2823
+ */
2824
+ ldaps: outputs.ProjectConnectorsLdap[];
2235
2825
  /**
2236
2826
  * Localize the language of your login and user journey screens with the Lokalise connector.
2237
2827
  */
2238
2828
  lokalises: outputs.ProjectConnectorsLokalise[];
2829
+ /**
2830
+ * Stream authentication audit logs and troubleshoot logs to Mixpanel.
2831
+ */
2832
+ mixpanels: outputs.ProjectConnectorsMixpanel[];
2239
2833
  /**
2240
2834
  * Track and send user event data (e.g. page views, purchases, etc.) across connected tools using the mParticle connector.
2241
2835
  */
@@ -2244,6 +2838,22 @@ export interface ProjectConnectors {
2244
2838
  * Stream authentication audit logs with the New Relic connector.
2245
2839
  */
2246
2840
  newrelics: outputs.ProjectConnectorsNewrelic[];
2841
+ /**
2842
+ * Send audit events and troubleshooting logs to an OpenTelemetry-compatible endpoint using OTLP over HTTP or gRPC.
2843
+ */
2844
+ opentelemetries: outputs.ProjectConnectorsOpentelemetry[];
2845
+ /**
2846
+ * Stream authentication audit logs with the Pendo connector.
2847
+ */
2848
+ pendos: outputs.ProjectConnectorsPendo[];
2849
+ /**
2850
+ * Authenticate against PingDirectory.
2851
+ */
2852
+ pingDirectories: outputs.ProjectConnectorsPingDirectory[];
2853
+ /**
2854
+ * Send emails using Postmark
2855
+ */
2856
+ postmarks: outputs.ProjectConnectorsPostmark[];
2247
2857
  /**
2248
2858
  * Get address autocompletions from Radar Autocomplete API.
2249
2859
  */
@@ -2252,6 +2862,10 @@ export interface ProjectConnectors {
2252
2862
  * Mitigate fraud using advanced risk analysis and add adaptive MFA with the reCAPTCHA Enterprise connector.
2253
2863
  */
2254
2864
  recaptchaEnterprises: outputs.ProjectConnectorsRecaptchaEnterprise[];
2865
+ /**
2866
+ * Use the reCAPTCHA v2 "I'm not a robot" checkbox widget with your flows.
2867
+ */
2868
+ recaptchaV2s: outputs.ProjectConnectorsRecaptchaV2[];
2255
2869
  /**
2256
2870
  * Prevent bot attacks on your login pages with the reCAPTCHA v3 connector.
2257
2871
  */
@@ -2260,6 +2874,10 @@ export interface ProjectConnectors {
2260
2874
  * Add image recognition capabilities for identity verification and fraud prevention with the Amazon Rekognition connector.
2261
2875
  */
2262
2876
  rekognitions: outputs.ProjectConnectorsRekognition[];
2877
+ /**
2878
+ * Query the FCC Reassigned Numbers Database (RND) to validate whether telephone numbers have been permanently disconnected (reassigned) since a specific date. Helps obtain Safe Harbor from TCPA liability by checking the most recent database update.
2879
+ */
2880
+ rndReassigneds: outputs.ProjectConnectorsRndReassigned[];
2263
2881
  /**
2264
2882
  * Send transactional messages with the Salesforce Marketing Cloud connector.
2265
2883
  */
@@ -2272,6 +2890,10 @@ export interface ProjectConnectors {
2272
2890
  * Evaluate customer risk using Sardine
2273
2891
  */
2274
2892
  sardines: outputs.ProjectConnectorsSardine[];
2893
+ /**
2894
+ * Provision and de-provision users to an external SCIM v2 endpoint as part of your Descope user journey.
2895
+ */
2896
+ scims: outputs.ProjectConnectorsScim[];
2275
2897
  /**
2276
2898
  * Orchestrate customer identity traits and signals from your Descope user journey with the Segment connector.
2277
2899
  */
@@ -2296,16 +2918,28 @@ export interface ProjectConnectors {
2296
2918
  * Simple Mail Transfer Protocol (SMTP) server for sending emails.
2297
2919
  */
2298
2920
  smtps: outputs.ProjectConnectorsSmtp[];
2921
+ /**
2922
+ * Stream authentication audit logs to your Snowflake data warehouse with the Snowflake connector.
2923
+ */
2924
+ snowflakes: outputs.ProjectConnectorsSnowflake[];
2299
2925
  /**
2300
2926
  * Amazon Simple Notification Service (SNS) for sending SMS messages through AWS.
2301
2927
  */
2302
2928
  sns: outputs.ProjectConnectorsSn[];
2303
2929
  /**
2304
- * Stream logs and audit events with the Sumo Logic connector.
2930
+ * Stream logs and audit events with the Splunk HTTP Event Collector (HEC).
2305
2931
  */
2306
- sumologics: outputs.ProjectConnectorsSumologic[];
2932
+ splunks: outputs.ProjectConnectorsSplunk[];
2307
2933
  /**
2308
- * Generate external tokens for user authentication in Supabase projects.
2934
+ * SQL connector for relational databases including PostgreSQL, MySQL, MariaDB, Microsoft SQL Server (MSSQL), Oracle, CockroachDB, and Amazon Redshift.
2935
+ */
2936
+ sqls: outputs.ProjectConnectorsSql[];
2937
+ /**
2938
+ * Stream logs and audit events with the Sumo Logic connector.
2939
+ */
2940
+ sumologics: outputs.ProjectConnectorsSumologic[];
2941
+ /**
2942
+ * Generate external tokens for user authentication in Supabase projects.
2309
2943
  */
2310
2944
  supabases: outputs.ProjectConnectorsSupabase[];
2311
2945
  /**
@@ -2328,6 +2962,14 @@ export interface ProjectConnectors {
2328
2962
  * Twilio Verify is an OTP service that can be used via text messages, instant messaging platforms, voice and e-mail. Choose this connector only if you are a Twilio Verify customer.
2329
2963
  */
2330
2964
  twilioVerifies: outputs.ProjectConnectorsTwilioVerify[];
2965
+ /**
2966
+ * SIM-based authentication and approval using Unibeam's OnSim technology for passwordless authentication and transaction approval.
2967
+ */
2968
+ unibeams: outputs.ProjectConnectorsUnibeam[];
2969
+ /**
2970
+ * Email validation with ZeroBounce
2971
+ */
2972
+ zerobounces: outputs.ProjectConnectorsZerobounce[];
2331
2973
  }
2332
2974
  export interface ProjectConnectorsAbuseipdb {
2333
2975
  /**
@@ -2344,6 +2986,29 @@ export interface ProjectConnectorsAbuseipdb {
2344
2986
  */
2345
2987
  name: string;
2346
2988
  }
2989
+ export interface ProjectConnectorsAlloy {
2990
+ /**
2991
+ * The Alloy API secret.
2992
+ */
2993
+ apiSecret: string;
2994
+ /**
2995
+ * The Alloy API token.
2996
+ */
2997
+ apiToken: string;
2998
+ /**
2999
+ * The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
3000
+ */
3001
+ baseUrl: string;
3002
+ /**
3003
+ * A description of what your connector is used for.
3004
+ */
3005
+ description: string;
3006
+ id: string;
3007
+ /**
3008
+ * A custom name for your connector.
3009
+ */
3010
+ name: string;
3011
+ }
2347
3012
  export interface ProjectConnectorsAmplitude {
2348
3013
  /**
2349
3014
  * The Amplitude API Key generated for the Descope service.
@@ -2367,6 +3032,33 @@ export interface ProjectConnectorsAmplitude {
2367
3032
  */
2368
3033
  serverZone: string;
2369
3034
  }
3035
+ export interface ProjectConnectorsArkose {
3036
+ /**
3037
+ * A custom base URL to use when loading the Arkose Labs client script. If not provided, the default value of `https://client-api.arkoselabs.com/v2` will be used.
3038
+ */
3039
+ clientBaseUrl: string;
3040
+ /**
3041
+ * A description of what your connector is used for.
3042
+ */
3043
+ description: string;
3044
+ id: string;
3045
+ /**
3046
+ * A custom name for your connector.
3047
+ */
3048
+ name: string;
3049
+ /**
3050
+ * The private key that can be copied from the Keys screen in the Arkose Labs portal.
3051
+ */
3052
+ privateKey: string;
3053
+ /**
3054
+ * The public key that's shown in the Keys screen in the Arkose Labs portal.
3055
+ */
3056
+ publicKey: string;
3057
+ /**
3058
+ * A custom base URL to use when verifying the session token using the Arkose Labs Verify API. If not provided, the default value of `https://verify-api.arkoselabs.com/api/v4` will be used.
3059
+ */
3060
+ verifyBaseUrl: string;
3061
+ }
2370
3062
  export interface ProjectConnectorsAuditWebhook {
2371
3063
  /**
2372
3064
  * Specify which events will be sent to the external audit service (including tenant selection).
@@ -2384,6 +3076,10 @@ export interface ProjectConnectorsAuditWebhook {
2384
3076
  * A description of what your connector is used for.
2385
3077
  */
2386
3078
  description: string;
3079
+ /**
3080
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3081
+ */
3082
+ engineId: string;
2387
3083
  /**
2388
3084
  * The headers to send with the request
2389
3085
  */
@@ -2431,6 +3127,10 @@ export interface ProjectConnectorsAuditWebhookAuthentication {
2431
3127
  * Bearer token for HTTP authentication.
2432
3128
  */
2433
3129
  bearerToken: string;
3130
+ /**
3131
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
3132
+ */
3133
+ oauth2ClientCredentials: outputs.ProjectConnectorsAuditWebhookAuthenticationOauth2ClientCredentials;
2434
3134
  }
2435
3135
  export interface ProjectConnectorsAuditWebhookAuthenticationApiKey {
2436
3136
  /**
@@ -2452,6 +3152,34 @@ export interface ProjectConnectorsAuditWebhookAuthenticationBasic {
2452
3152
  */
2453
3153
  username: string;
2454
3154
  }
3155
+ export interface ProjectConnectorsAuditWebhookAuthenticationOauth2ClientCredentials {
3156
+ /**
3157
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
3158
+ */
3159
+ authStyle: string;
3160
+ /**
3161
+ * The token endpoint URL used to request an access token.
3162
+ */
3163
+ authUrl: string;
3164
+ /**
3165
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
3166
+ */
3167
+ clientId: string;
3168
+ /**
3169
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
3170
+ */
3171
+ clientSecret: string;
3172
+ /**
3173
+ * A space-separated list of OAuth scopes to request when fetching the access token.
3174
+ */
3175
+ scopes: string;
3176
+ /**
3177
+ * Additional headers to include in the token request sent to the token endpoint.
3178
+ */
3179
+ tokenRequestHeaders: {
3180
+ [key: string]: string;
3181
+ };
3182
+ }
2455
3183
  export interface ProjectConnectorsAwsS3 {
2456
3184
  /**
2457
3185
  * The unique AWS access key ID.
@@ -2477,11 +3205,19 @@ export interface ProjectConnectorsAwsS3 {
2477
3205
  * A description of what your connector is used for.
2478
3206
  */
2479
3207
  description: string;
3208
+ /**
3209
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3210
+ */
3211
+ engineId: string;
2480
3212
  /**
2481
3213
  * The external ID to use when assuming the role.
2482
3214
  */
2483
3215
  externalId: string;
2484
3216
  id: string;
3217
+ /**
3218
+ * Whether to mask personally identifiable information in the logs.
3219
+ */
3220
+ maskPii: boolean;
2485
3221
  /**
2486
3222
  * A custom name for your connector.
2487
3223
  */
@@ -2517,6 +3253,49 @@ export interface ProjectConnectorsAwsS3AuditFilter {
2517
3253
  */
2518
3254
  values: string[];
2519
3255
  }
3256
+ export interface ProjectConnectorsAwsSesEmailValidation {
3257
+ /**
3258
+ * AWS access key ID.
3259
+ */
3260
+ accessKeyId: string;
3261
+ /**
3262
+ * The authentication type to use.
3263
+ */
3264
+ authType: string;
3265
+ /**
3266
+ * A description of what your connector is used for.
3267
+ */
3268
+ description: string;
3269
+ /**
3270
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3271
+ */
3272
+ engineId: string;
3273
+ /**
3274
+ * The external ID to use when assuming the role.
3275
+ */
3276
+ externalId: string;
3277
+ id: string;
3278
+ /**
3279
+ * A custom name for your connector.
3280
+ */
3281
+ name: string;
3282
+ /**
3283
+ * The AWS region to which this client will send requests. (e.g. us-east-1.)
3284
+ */
3285
+ region: string;
3286
+ /**
3287
+ * The Amazon Resource Name (ARN) of the role to assume.
3288
+ */
3289
+ roleArn: string;
3290
+ /**
3291
+ * AWS secret access key.
3292
+ */
3293
+ secretAccessKey: string;
3294
+ /**
3295
+ * (Optional) A security or session token to use with these credentials. Usually present for temporary credentials.
3296
+ */
3297
+ sessionToken: string;
3298
+ }
2520
3299
  export interface ProjectConnectorsAwsTranslate {
2521
3300
  /**
2522
3301
  * AWS access key ID.
@@ -2526,6 +3305,10 @@ export interface ProjectConnectorsAwsTranslate {
2526
3305
  * A description of what your connector is used for.
2527
3306
  */
2528
3307
  description: string;
3308
+ /**
3309
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3310
+ */
3311
+ engineId: string;
2529
3312
  id: string;
2530
3313
  /**
2531
3314
  * A custom name for your connector.
@@ -2563,6 +3346,159 @@ export interface ProjectConnectorsBitsight {
2563
3346
  */
2564
3347
  name: string;
2565
3348
  }
3349
+ export interface ProjectConnectorsCoralogix {
3350
+ /**
3351
+ * Whether to enable streaming of audit events.
3352
+ */
3353
+ auditEnabled: boolean;
3354
+ /**
3355
+ * Specify which events will be sent to the external audit service (including tenant selection).
3356
+ */
3357
+ auditFilters: outputs.ProjectConnectorsCoralogixAuditFilter[];
3358
+ /**
3359
+ * Bearer token issued by Coralogix as Send-Your-Data API key
3360
+ */
3361
+ bearerToken: string;
3362
+ /**
3363
+ * A description of what your connector is used for.
3364
+ */
3365
+ description: string;
3366
+ /**
3367
+ * The ingress OpenTelemetry endpoint URL.
3368
+ */
3369
+ endpoint: string;
3370
+ id: string;
3371
+ /**
3372
+ * Whether to mask personally identifiable information in the logs.
3373
+ */
3374
+ maskPii: boolean;
3375
+ /**
3376
+ * A custom name for your connector.
3377
+ */
3378
+ name: string;
3379
+ /**
3380
+ * Whether to send troubleshooting events.
3381
+ */
3382
+ troubleshootLogEnabled: boolean;
3383
+ }
3384
+ export interface ProjectConnectorsCoralogixAuditFilter {
3385
+ /**
3386
+ * The field name to filter on (either 'actions' or 'tenants').
3387
+ */
3388
+ key: string;
3389
+ /**
3390
+ * The filter operation to apply ('includes' or 'excludes').
3391
+ */
3392
+ operator: string;
3393
+ /**
3394
+ * The list of values to match against for the filter.
3395
+ */
3396
+ values: string[];
3397
+ }
3398
+ export interface ProjectConnectorsCribl {
3399
+ /**
3400
+ * Whether to enable streaming of audit events.
3401
+ */
3402
+ auditEnabled: boolean;
3403
+ /**
3404
+ * Specify which events will be sent to the external audit service (including tenant selection).
3405
+ */
3406
+ auditFilters: outputs.ProjectConnectorsCriblAuditFilter[];
3407
+ /**
3408
+ * A shared secret token for authenticating with the Cribl HTTP source. This token is defined on the source and is strongly recommended for security reasons.
3409
+ */
3410
+ authToken: string;
3411
+ /**
3412
+ * A description of what your connector is used for.
3413
+ */
3414
+ description: string;
3415
+ /**
3416
+ * The base URL of your Cribl Stream HTTP source. For Cribl Cloud, the default http source looks something like https://\n\n.main.\n\n.cribl.cloud:10080. You can also define a custom source (find this in your Cribl Cloud portal under Data Sources). For self-hosted deployments, use https://\n\n:10080 or however you have it configured.
3417
+ */
3418
+ endpoint: string;
3419
+ id: string;
3420
+ /**
3421
+ * Whether to mask personally identifiable information in the logs.
3422
+ */
3423
+ maskPii: boolean;
3424
+ /**
3425
+ * A custom name for your connector.
3426
+ */
3427
+ name: string;
3428
+ /**
3429
+ * An optional source identifier for events in Cribl (defaults to 'descope').
3430
+ */
3431
+ source: string;
3432
+ /**
3433
+ * Whether to send troubleshooting events.
3434
+ */
3435
+ troubleshootLogEnabled: boolean;
3436
+ }
3437
+ export interface ProjectConnectorsCriblAuditFilter {
3438
+ /**
3439
+ * The field name to filter on (either 'actions' or 'tenants').
3440
+ */
3441
+ key: string;
3442
+ /**
3443
+ * The filter operation to apply ('includes' or 'excludes').
3444
+ */
3445
+ operator: string;
3446
+ /**
3447
+ * The list of values to match against for the filter.
3448
+ */
3449
+ values: string[];
3450
+ }
3451
+ export interface ProjectConnectorsDarwinium {
3452
+ /**
3453
+ * The default result to return if no result is available.
3454
+ */
3455
+ defaultResult: string;
3456
+ /**
3457
+ * A description of what your connector is used for.
3458
+ */
3459
+ description: string;
3460
+ id: string;
3461
+ /**
3462
+ * The name of the Darwinium journey to use for profiling.
3463
+ */
3464
+ journeyName: string;
3465
+ /**
3466
+ * A custom name for your connector.
3467
+ */
3468
+ name: string;
3469
+ /**
3470
+ * The name of the Darwinium Native Mobile API to use.
3471
+ */
3472
+ nativeApiName: string;
3473
+ /**
3474
+ * The key name for the native profiling blob sent via the client parameter. If not provided, the default key of 'nativeProfilingBlob' will be used.
3475
+ */
3476
+ nativeBlobKeyName: string;
3477
+ /**
3478
+ * The name of the Darwinium node.
3479
+ */
3480
+ nodeName: string;
3481
+ /**
3482
+ * The passphrase for the PEM certificate, if applicable.
3483
+ */
3484
+ passphrase: string;
3485
+ /**
3486
+ * The PEM certificate for client authentication.
3487
+ */
3488
+ pemCertificate: string;
3489
+ /**
3490
+ * The private key for client authentication.
3491
+ */
3492
+ privateKey: string;
3493
+ /**
3494
+ * The custom URL where the Darwinium Tags script is hosted. If not provided, the default Darwinium script URL will be used.
3495
+ */
3496
+ profilingTagsScriptUrl: string;
3497
+ /**
3498
+ * The name of the Darwinium Web API to use.
3499
+ */
3500
+ webApiName: string;
3501
+ }
2566
3502
  export interface ProjectConnectorsDatadog {
2567
3503
  /**
2568
3504
  * The unique Datadog organization key.
@@ -2580,6 +3516,10 @@ export interface ProjectConnectorsDatadog {
2580
3516
  * A description of what your connector is used for.
2581
3517
  */
2582
3518
  description: string;
3519
+ /**
3520
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3521
+ */
3522
+ engineId: string;
2583
3523
  id: string;
2584
3524
  /**
2585
3525
  * Whether to mask personally identifiable information in the logs.
@@ -2593,6 +3533,14 @@ export interface ProjectConnectorsDatadog {
2593
3533
  * The Datadog site to send logs to. Default is `datadoghq.com`. European, free tier and other customers should set their site accordingly.
2594
3534
  */
2595
3535
  site: string;
3536
+ /**
3537
+ * An optional custom source to use for log entries sent to Datadog. This can be used to differentiate between environments (e.g. `production`, `staging`). If left empty, the default Descope source will be used.
3538
+ */
3539
+ source: string;
3540
+ /**
3541
+ * An optional comma-separated list of tags to append to all log entries sent to Datadog (e.g. `env:production,team:auth`). These are added in addition to any default tags. If left empty, only the default Descope tags will be used.
3542
+ */
3543
+ tags: string;
2596
3544
  /**
2597
3545
  * Whether to send troubleshooting events.
2598
3546
  */
@@ -2781,6 +3729,10 @@ export interface ProjectConnectorsExternalTokenHttpAuthentication {
2781
3729
  * Bearer token for HTTP authentication.
2782
3730
  */
2783
3731
  bearerToken: string;
3732
+ /**
3733
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
3734
+ */
3735
+ oauth2ClientCredentials: outputs.ProjectConnectorsExternalTokenHttpAuthenticationOauth2ClientCredentials;
2784
3736
  }
2785
3737
  export interface ProjectConnectorsExternalTokenHttpAuthenticationApiKey {
2786
3738
  /**
@@ -2802,20 +3754,48 @@ export interface ProjectConnectorsExternalTokenHttpAuthenticationBasic {
2802
3754
  */
2803
3755
  username: string;
2804
3756
  }
2805
- export interface ProjectConnectorsFingerprint {
3757
+ export interface ProjectConnectorsExternalTokenHttpAuthenticationOauth2ClientCredentials {
2806
3758
  /**
2807
- * The Cloudflare integration Endpoint URL.
3759
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
2808
3760
  */
2809
- cloudflareEndpointUrl: string;
3761
+ authStyle: string;
2810
3762
  /**
2811
- * The Cloudflare integration Script URL.
3763
+ * The token endpoint URL used to request an access token.
2812
3764
  */
2813
- cloudflareScriptUrl: string;
3765
+ authUrl: string;
2814
3766
  /**
2815
- * A description of what your connector is used for.
3767
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
2816
3768
  */
2817
- description: string;
2818
- id: string;
3769
+ clientId: string;
3770
+ /**
3771
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
3772
+ */
3773
+ clientSecret: string;
3774
+ /**
3775
+ * A space-separated list of OAuth scopes to request when fetching the access token.
3776
+ */
3777
+ scopes: string;
3778
+ /**
3779
+ * Additional headers to include in the token request sent to the token endpoint.
3780
+ */
3781
+ tokenRequestHeaders: {
3782
+ [key: string]: string;
3783
+ };
3784
+ }
3785
+ export interface ProjectConnectorsFingerprint {
3786
+ /**
3787
+ * The Cloudflare integration Endpoint URL.
3788
+ */
3789
+ cloudflareEndpointUrl: string;
3790
+ /**
3791
+ * The Cloudflare integration Script URL.
3792
+ */
3793
+ cloudflareScriptUrl: string;
3794
+ /**
3795
+ * A description of what your connector is used for.
3796
+ */
3797
+ description: string;
3798
+ id: string;
2819
3799
  /**
2820
3800
  * A custom name for your connector.
2821
3801
  */
@@ -2853,6 +3833,10 @@ export interface ProjectConnectorsFirebaseAdmin {
2853
3833
  * A description of what your connector is used for.
2854
3834
  */
2855
3835
  description: string;
3836
+ /**
3837
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3838
+ */
3839
+ engineId: string;
2856
3840
  id: string;
2857
3841
  /**
2858
3842
  * A custom name for your connector.
@@ -2952,6 +3936,10 @@ export interface ProjectConnectorsGenericEmailGatewayAuthentication {
2952
3936
  * Bearer token for HTTP authentication.
2953
3937
  */
2954
3938
  bearerToken: string;
3939
+ /**
3940
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
3941
+ */
3942
+ oauth2ClientCredentials: outputs.ProjectConnectorsGenericEmailGatewayAuthenticationOauth2ClientCredentials;
2955
3943
  }
2956
3944
  export interface ProjectConnectorsGenericEmailGatewayAuthenticationApiKey {
2957
3945
  /**
@@ -2973,6 +3961,34 @@ export interface ProjectConnectorsGenericEmailGatewayAuthenticationBasic {
2973
3961
  */
2974
3962
  username: string;
2975
3963
  }
3964
+ export interface ProjectConnectorsGenericEmailGatewayAuthenticationOauth2ClientCredentials {
3965
+ /**
3966
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
3967
+ */
3968
+ authStyle: string;
3969
+ /**
3970
+ * The token endpoint URL used to request an access token.
3971
+ */
3972
+ authUrl: string;
3973
+ /**
3974
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
3975
+ */
3976
+ clientId: string;
3977
+ /**
3978
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
3979
+ */
3980
+ clientSecret: string;
3981
+ /**
3982
+ * A space-separated list of OAuth scopes to request when fetching the access token.
3983
+ */
3984
+ scopes: string;
3985
+ /**
3986
+ * Additional headers to include in the token request sent to the token endpoint.
3987
+ */
3988
+ tokenRequestHeaders: {
3989
+ [key: string]: string;
3990
+ };
3991
+ }
2976
3992
  export interface ProjectConnectorsGenericSmsGateway {
2977
3993
  /**
2978
3994
  * Authentication Information
@@ -3027,6 +4043,10 @@ export interface ProjectConnectorsGenericSmsGatewayAuthentication {
3027
4043
  * Bearer token for HTTP authentication.
3028
4044
  */
3029
4045
  bearerToken: string;
4046
+ /**
4047
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
4048
+ */
4049
+ oauth2ClientCredentials: outputs.ProjectConnectorsGenericSmsGatewayAuthenticationOauth2ClientCredentials;
3030
4050
  }
3031
4051
  export interface ProjectConnectorsGenericSmsGatewayAuthenticationApiKey {
3032
4052
  /**
@@ -3048,6 +4068,34 @@ export interface ProjectConnectorsGenericSmsGatewayAuthenticationBasic {
3048
4068
  */
3049
4069
  username: string;
3050
4070
  }
4071
+ export interface ProjectConnectorsGenericSmsGatewayAuthenticationOauth2ClientCredentials {
4072
+ /**
4073
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
4074
+ */
4075
+ authStyle: string;
4076
+ /**
4077
+ * The token endpoint URL used to request an access token.
4078
+ */
4079
+ authUrl: string;
4080
+ /**
4081
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
4082
+ */
4083
+ clientId: string;
4084
+ /**
4085
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
4086
+ */
4087
+ clientSecret: string;
4088
+ /**
4089
+ * A space-separated list of OAuth scopes to request when fetching the access token.
4090
+ */
4091
+ scopes: string;
4092
+ /**
4093
+ * Additional headers to include in the token request sent to the token endpoint.
4094
+ */
4095
+ tokenRequestHeaders: {
4096
+ [key: string]: string;
4097
+ };
4098
+ }
3051
4099
  export interface ProjectConnectorsGoogleCloudLogging {
3052
4100
  /**
3053
4101
  * Whether to enable streaming of audit events.
@@ -3061,6 +4109,10 @@ export interface ProjectConnectorsGoogleCloudLogging {
3061
4109
  * A description of what your connector is used for.
3062
4110
  */
3063
4111
  description: string;
4112
+ /**
4113
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
4114
+ */
4115
+ engineId: string;
3064
4116
  id: string;
3065
4117
  /**
3066
4118
  * A custom name for your connector.
@@ -3094,6 +4146,10 @@ export interface ProjectConnectorsGoogleCloudTranslation {
3094
4146
  * A description of what your connector is used for.
3095
4147
  */
3096
4148
  description: string;
4149
+ /**
4150
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
4151
+ */
4152
+ engineId: string;
3097
4153
  id: string;
3098
4154
  /**
3099
4155
  * A custom name for your connector.
@@ -3135,11 +4191,95 @@ export interface ProjectConnectorsGoogleMapsPlace {
3135
4191
  */
3136
4192
  region: string;
3137
4193
  }
4194
+ export interface ProjectConnectorsGroundcover {
4195
+ /**
4196
+ * Whether to enable streaming of audit events.
4197
+ */
4198
+ auditEnabled: boolean;
4199
+ /**
4200
+ * Specify which events will be sent to the external audit service (including tenant selection).
4201
+ */
4202
+ auditFilters: outputs.ProjectConnectorsGroundcoverAuditFilter[];
4203
+ /**
4204
+ * A description of what your connector is used for.
4205
+ */
4206
+ description: string;
4207
+ /**
4208
+ * The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
4209
+ */
4210
+ endpoint: string;
4211
+ id: string;
4212
+ /**
4213
+ * Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
4214
+ */
4215
+ ingestionKey: string;
4216
+ /**
4217
+ * Whether to mask personally identifiable information in the logs.
4218
+ */
4219
+ maskPii: boolean;
4220
+ /**
4221
+ * A custom name for your connector.
4222
+ */
4223
+ name: string;
4224
+ /**
4225
+ * Whether to send troubleshooting events.
4226
+ */
4227
+ troubleshootLogEnabled: boolean;
4228
+ }
4229
+ export interface ProjectConnectorsGroundcoverAuditFilter {
4230
+ /**
4231
+ * The field name to filter on (either 'actions' or 'tenants').
4232
+ */
4233
+ key: string;
4234
+ /**
4235
+ * The filter operation to apply ('includes' or 'excludes').
4236
+ */
4237
+ operator: string;
4238
+ /**
4239
+ * The list of values to match against for the filter.
4240
+ */
4241
+ values: string[];
4242
+ }
4243
+ export interface ProjectConnectorsHcaptcha {
4244
+ /**
4245
+ * When configured, the hCaptcha 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.
4246
+ */
4247
+ assessmentScore: number;
4248
+ /**
4249
+ * The bot threshold is used to determine whether the request is a bot or a human. The score ranges between 0 and 1, where 1 is a human interaction and 0 is a bot. If the score is below this threshold, the request is considered a bot.
4250
+ */
4251
+ botThreshold: number;
4252
+ /**
4253
+ * A description of what your connector is used for.
4254
+ */
4255
+ description: string;
4256
+ id: string;
4257
+ /**
4258
+ * A custom name for your connector.
4259
+ */
4260
+ name: string;
4261
+ /**
4262
+ * Override the default assessment model. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
4263
+ */
4264
+ overrideAssessment: boolean;
4265
+ /**
4266
+ * The secret key authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
4267
+ */
4268
+ secretKey: string;
4269
+ /**
4270
+ * The site key is used to invoke hCaptcha service on your site or mobile application.
4271
+ */
4272
+ siteKey: string;
4273
+ }
3138
4274
  export interface ProjectConnectorsHibp {
3139
4275
  /**
3140
4276
  * A description of what your connector is used for.
3141
4277
  */
3142
4278
  description: string;
4279
+ /**
4280
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
4281
+ */
4282
+ engineId: string;
3143
4283
  id: string;
3144
4284
  /**
3145
4285
  * A custom name for your connector.
@@ -3151,6 +4291,34 @@ export interface ProjectConnectorsHttp {
3151
4291
  * Authentication Information
3152
4292
  */
3153
4293
  authentication: outputs.ProjectConnectorsHttpAuthentication;
4294
+ /**
4295
+ * The unique AWS access key ID.
4296
+ */
4297
+ awsAccessKeyId: string;
4298
+ /**
4299
+ * Apply AWS signature version 4 authentication to the request.
4300
+ */
4301
+ awsAuthType: string;
4302
+ /**
4303
+ * The external ID to use when assuming the role.
4304
+ */
4305
+ awsExternalId: string;
4306
+ /**
4307
+ * The AWS region, e.g. `us-east-1`.
4308
+ */
4309
+ awsRegion: string;
4310
+ /**
4311
+ * The Amazon Resource Name (ARN) of the role to assume.
4312
+ */
4313
+ awsRoleArn: string;
4314
+ /**
4315
+ * The secret AWS access key.
4316
+ */
4317
+ awsSecretAccessKey: string;
4318
+ /**
4319
+ * The AWS service to target, e.g. `lambda`, `execute-api`, `s3`, etc.
4320
+ */
4321
+ awsService: string;
3154
4322
  /**
3155
4323
  * The base URL to fetch
3156
4324
  */
@@ -3159,6 +4327,10 @@ export interface ProjectConnectorsHttp {
3159
4327
  * A description of what your connector is used for.
3160
4328
  */
3161
4329
  description: string;
4330
+ /**
4331
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
4332
+ */
4333
+ engineId: string;
3162
4334
  /**
3163
4335
  * The headers to send with the request
3164
4336
  */
@@ -3171,7 +4343,7 @@ export interface ProjectConnectorsHttp {
3171
4343
  hmacSecret: string;
3172
4344
  id: string;
3173
4345
  /**
3174
- * 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
4346
+ * The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
3175
4347
  */
3176
4348
  includeHeadersInContext: boolean;
3177
4349
  /**
@@ -3182,6 +4354,26 @@ export interface ProjectConnectorsHttp {
3182
4354
  * A custom name for your connector.
3183
4355
  */
3184
4356
  name: string;
4357
+ /**
4358
+ * HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
4359
+ */
4360
+ rfc9421Components: string;
4361
+ /**
4362
+ * Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
4363
+ */
4364
+ rfc9421KeyId: string;
4365
+ /**
4366
+ * Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
4367
+ */
4368
+ rfc9421PrivateKey: string;
4369
+ /**
4370
+ * How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
4371
+ */
4372
+ rfc9421SignatureTtl: number;
4373
+ /**
4374
+ * Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
4375
+ */
4376
+ rfc9421SigningEnabled: boolean;
3185
4377
  /**
3186
4378
  * Whether the connector should send all requests from specific static IPs.
3187
4379
  */
@@ -3200,6 +4392,10 @@ export interface ProjectConnectorsHttpAuthentication {
3200
4392
  * Bearer token for HTTP authentication.
3201
4393
  */
3202
4394
  bearerToken: string;
4395
+ /**
4396
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
4397
+ */
4398
+ oauth2ClientCredentials: outputs.ProjectConnectorsHttpAuthenticationOauth2ClientCredentials;
3203
4399
  }
3204
4400
  export interface ProjectConnectorsHttpAuthenticationApiKey {
3205
4401
  /**
@@ -3221,6 +4417,34 @@ export interface ProjectConnectorsHttpAuthenticationBasic {
3221
4417
  */
3222
4418
  username: string;
3223
4419
  }
4420
+ export interface ProjectConnectorsHttpAuthenticationOauth2ClientCredentials {
4421
+ /**
4422
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
4423
+ */
4424
+ authStyle: string;
4425
+ /**
4426
+ * The token endpoint URL used to request an access token.
4427
+ */
4428
+ authUrl: string;
4429
+ /**
4430
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
4431
+ */
4432
+ clientId: string;
4433
+ /**
4434
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
4435
+ */
4436
+ clientSecret: string;
4437
+ /**
4438
+ * A space-separated list of OAuth scopes to request when fetching the access token.
4439
+ */
4440
+ scopes: string;
4441
+ /**
4442
+ * Additional headers to include in the token request sent to the token endpoint.
4443
+ */
4444
+ tokenRequestHeaders: {
4445
+ [key: string]: string;
4446
+ };
4447
+ }
3224
4448
  export interface ProjectConnectorsHubspot {
3225
4449
  /**
3226
4450
  * The HubSpot private API access token generated for the Descope service.
@@ -3260,146 +4484,478 @@ export interface ProjectConnectorsIncode {
3260
4484
  /**
3261
4485
  * Your wanted InCode's flow ID.
3262
4486
  */
3263
- flowId: string;
3264
- id: string;
4487
+ flowId: string;
4488
+ id: string;
4489
+ /**
4490
+ * A custom name for your connector.
4491
+ */
4492
+ name: string;
4493
+ }
4494
+ export interface ProjectConnectorsIntercom {
4495
+ /**
4496
+ * A description of what your connector is used for.
4497
+ */
4498
+ description: string;
4499
+ id: string;
4500
+ /**
4501
+ * A custom name for your connector.
4502
+ */
4503
+ name: string;
4504
+ /**
4505
+ * Regional Hosting - US, EU, or AU. default: US
4506
+ */
4507
+ region: string;
4508
+ /**
4509
+ * The Intercom access token.
4510
+ */
4511
+ token: string;
4512
+ }
4513
+ export interface ProjectConnectorsLdap {
4514
+ /**
4515
+ * The Distinguished Name to bind with for searching.
4516
+ */
4517
+ bindDn: string;
4518
+ /**
4519
+ * The password for the bind DN.
4520
+ */
4521
+ bindPassword: string;
4522
+ /**
4523
+ * The Certificate Authority certificate in PEM format for validating the server certificate.
4524
+ */
4525
+ caCertificate: string;
4526
+ /**
4527
+ * The client certificate in PEM format for mTLS authentication.
4528
+ */
4529
+ clientCertificate: string;
4530
+ /**
4531
+ * The client private key in PEM format for mTLS authentication.
4532
+ */
4533
+ clientKey: string;
4534
+ /**
4535
+ * A description of what your connector is used for.
4536
+ */
4537
+ description: string;
4538
+ id: string;
4539
+ /**
4540
+ * A custom name for your connector.
4541
+ */
4542
+ name: string;
4543
+ /**
4544
+ * Reject connections to LDAP servers with invalid certificates.
4545
+ */
4546
+ rejectUnauthorized: boolean;
4547
+ /**
4548
+ * The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
4549
+ */
4550
+ serverUrl: string;
4551
+ /**
4552
+ * Enable mutual TLS authentication for LDAP connection.
4553
+ */
4554
+ useMtls: boolean;
4555
+ }
4556
+ export interface ProjectConnectorsLokalise {
4557
+ /**
4558
+ * Lokalise API token.
4559
+ */
4560
+ apiToken: string;
4561
+ /**
4562
+ * (Optional) The ID of the payment card to use for translation orders. If not provided, the team credit will be used.
4563
+ */
4564
+ cardId: string;
4565
+ /**
4566
+ * A description of what your connector is used for.
4567
+ */
4568
+ description: string;
4569
+ id: string;
4570
+ /**
4571
+ * A custom name for your connector.
4572
+ */
4573
+ name: string;
4574
+ /**
4575
+ * Lokalise project ID.
4576
+ */
4577
+ projectId: string;
4578
+ /**
4579
+ * Lokalise team ID. If not provided, the oldest available team will be used.
4580
+ */
4581
+ teamId: string;
4582
+ /**
4583
+ * The translation provider to use ('gengo', 'google', 'lokalise', 'deepl'), default is 'deepl'.
4584
+ */
4585
+ translationProvider: string;
4586
+ }
4587
+ export interface ProjectConnectorsMixpanel {
4588
+ /**
4589
+ * The Mixpanel API secret key used for authenticating API requests.
4590
+ */
4591
+ apiSecret: string;
4592
+ /**
4593
+ * Whether to enable streaming of audit events.
4594
+ */
4595
+ auditEnabled: boolean;
4596
+ /**
4597
+ * Specify which events will be sent to the external audit service (including tenant selection).
4598
+ */
4599
+ auditFilters: outputs.ProjectConnectorsMixpanelAuditFilter[];
4600
+ /**
4601
+ * A description of what your connector is used for.
4602
+ */
4603
+ description: string;
4604
+ /**
4605
+ * Indicates if your Mixpanel project data is stored in the EU region.
4606
+ */
4607
+ euResidency: boolean;
4608
+ id: string;
4609
+ /**
4610
+ * Specify a custom prefix for all log fields. The default prefix is `descope.`.
4611
+ */
4612
+ logsPrefix: string;
4613
+ /**
4614
+ * A custom name for your connector.
4615
+ */
4616
+ name: string;
4617
+ /**
4618
+ * Enable this option to use a custom prefix for log fields.
4619
+ */
4620
+ overrideLogsPrefix: boolean;
4621
+ /**
4622
+ * The unique identifier for your Mixpanel project.
4623
+ */
4624
+ projectId: string;
4625
+ /**
4626
+ * The unique Mixpanel project token used to identify the project where data will be sent.
4627
+ */
4628
+ projectToken: string;
4629
+ /**
4630
+ * The Mixpanel service account secret used for integration.
4631
+ */
4632
+ serviceAccountSecret: string;
4633
+ /**
4634
+ * The Mixpanel service account username used for integration.
4635
+ */
4636
+ serviceAccountUsername: string;
4637
+ /**
4638
+ * Whether to send troubleshooting events.
4639
+ */
4640
+ troubleshootLogEnabled: boolean;
4641
+ }
4642
+ export interface ProjectConnectorsMixpanelAuditFilter {
4643
+ /**
4644
+ * The field name to filter on (either 'actions' or 'tenants').
4645
+ */
4646
+ key: string;
4647
+ /**
4648
+ * The filter operation to apply ('includes' or 'excludes').
4649
+ */
4650
+ operator: string;
4651
+ /**
4652
+ * The list of values to match against for the filter.
4653
+ */
4654
+ values: string[];
4655
+ }
4656
+ export interface ProjectConnectorsMparticle {
4657
+ /**
4658
+ * The mParticle Server to Server Key generated for the Descope service.
4659
+ */
4660
+ apiKey: string;
4661
+ /**
4662
+ * The mParticle Server to Server Secret generated for the Descope service.
4663
+ */
4664
+ apiSecret: string;
4665
+ /**
4666
+ * The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
4667
+ */
4668
+ baseUrl: string;
4669
+ /**
4670
+ * The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
4671
+ */
4672
+ defaultEnvironment: string;
4673
+ /**
4674
+ * A description of what your connector is used for.
4675
+ */
4676
+ description: string;
4677
+ id: string;
4678
+ /**
4679
+ * A custom name for your connector.
4680
+ */
4681
+ name: string;
4682
+ /**
4683
+ * Whether the connector should send all requests from specific static IPs.
4684
+ */
4685
+ useStaticIps: boolean;
4686
+ }
4687
+ export interface ProjectConnectorsNewrelic {
4688
+ /**
4689
+ * Ingest License Key of the account you want to report data to.
4690
+ */
4691
+ apiKey: string;
4692
+ /**
4693
+ * Whether to enable streaming of audit events.
4694
+ */
4695
+ auditEnabled: boolean;
4696
+ /**
4697
+ * Specify which events will be sent to the external audit service (including tenant selection).
4698
+ */
4699
+ auditFilters: outputs.ProjectConnectorsNewrelicAuditFilter[];
4700
+ /**
4701
+ * The New Relic data center the account belongs to. Possible values are: `US`, `EU`, `FedRAMP`. Default is `US`.
4702
+ */
4703
+ dataCenter: string;
4704
+ /**
4705
+ * A description of what your connector is used for.
4706
+ */
4707
+ description: string;
4708
+ id: string;
4709
+ /**
4710
+ * Specify a custom prefix for all log fields. The default prefix is `descope.`.
4711
+ */
4712
+ logsPrefix: string;
4713
+ /**
4714
+ * A custom name for your connector.
4715
+ */
4716
+ name: string;
4717
+ /**
4718
+ * Enable this option to use a custom prefix for log fields.
4719
+ */
4720
+ overrideLogsPrefix: boolean;
4721
+ /**
4722
+ * Whether to send troubleshooting events.
4723
+ */
4724
+ troubleshootLogEnabled: boolean;
4725
+ }
4726
+ export interface ProjectConnectorsNewrelicAuditFilter {
4727
+ /**
4728
+ * The field name to filter on (either 'actions' or 'tenants').
4729
+ */
4730
+ key: string;
4731
+ /**
4732
+ * The filter operation to apply ('includes' or 'excludes').
4733
+ */
4734
+ operator: string;
4735
+ /**
4736
+ * The list of values to match against for the filter.
4737
+ */
4738
+ values: string[];
4739
+ }
4740
+ export interface ProjectConnectorsOpentelemetry {
4741
+ /**
4742
+ * Whether to enable streaming of audit events.
4743
+ */
4744
+ auditEnabled: boolean;
4745
+ /**
4746
+ * Specify which events will be sent to the external audit service (including tenant selection).
4747
+ */
4748
+ auditFilters: outputs.ProjectConnectorsOpentelemetryAuditFilter[];
4749
+ /**
4750
+ * Authentication Information
4751
+ */
4752
+ authentication: outputs.ProjectConnectorsOpentelemetryAuthentication;
4753
+ /**
4754
+ * A description of what your connector is used for.
4755
+ */
4756
+ description: string;
4757
+ /**
4758
+ * The OTLP endpoint URL.
4759
+ */
4760
+ endpoint: string;
4761
+ /**
4762
+ * The headers to send with the request
4763
+ */
4764
+ headers: {
4765
+ [key: string]: string;
4766
+ };
4767
+ id: string;
4768
+ /**
4769
+ * Will ignore certificate errors raised by the client
4770
+ */
4771
+ insecure: boolean;
4772
+ /**
4773
+ * A custom name for your connector.
4774
+ */
4775
+ name: string;
4776
+ /**
4777
+ * Protocol to use for OTLP: http or grpc.
4778
+ */
4779
+ protocol: string;
4780
+ /**
4781
+ * Whether to send troubleshooting events.
4782
+ */
4783
+ troubleshootLogEnabled: boolean;
4784
+ }
4785
+ export interface ProjectConnectorsOpentelemetryAuditFilter {
4786
+ /**
4787
+ * The field name to filter on (either 'actions' or 'tenants').
4788
+ */
4789
+ key: string;
4790
+ /**
4791
+ * The filter operation to apply ('includes' or 'excludes').
4792
+ */
4793
+ operator: string;
4794
+ /**
4795
+ * The list of values to match against for the filter.
4796
+ */
4797
+ values: string[];
4798
+ }
4799
+ export interface ProjectConnectorsOpentelemetryAuthentication {
4800
+ /**
4801
+ * API key authentication configuration.
4802
+ */
4803
+ apiKey: outputs.ProjectConnectorsOpentelemetryAuthenticationApiKey;
3265
4804
  /**
3266
- * A custom name for your connector.
4805
+ * Basic authentication credentials (username and password).
3267
4806
  */
3268
- name: string;
3269
- }
3270
- export interface ProjectConnectorsIntercom {
4807
+ basic: outputs.ProjectConnectorsOpentelemetryAuthenticationBasic;
3271
4808
  /**
3272
- * A description of what your connector is used for.
4809
+ * Bearer token for HTTP authentication.
3273
4810
  */
3274
- description: string;
3275
- id: string;
4811
+ bearerToken: string;
3276
4812
  /**
3277
- * A custom name for your connector.
4813
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
3278
4814
  */
3279
- name: string;
4815
+ oauth2ClientCredentials: outputs.ProjectConnectorsOpentelemetryAuthenticationOauth2ClientCredentials;
4816
+ }
4817
+ export interface ProjectConnectorsOpentelemetryAuthenticationApiKey {
3280
4818
  /**
3281
- * Regional Hosting - US, EU, or AU. default: US
4819
+ * The API key.
3282
4820
  */
3283
- region: string;
4821
+ key: string;
3284
4822
  /**
3285
- * The Intercom access token.
4823
+ * The API secret.
3286
4824
  */
3287
4825
  token: string;
3288
4826
  }
3289
- export interface ProjectConnectorsLokalise {
4827
+ export interface ProjectConnectorsOpentelemetryAuthenticationBasic {
3290
4828
  /**
3291
- * Lokalise API token.
4829
+ * Password for basic HTTP authentication.
3292
4830
  */
3293
- apiToken: string;
4831
+ password: string;
3294
4832
  /**
3295
- * (Optional) The ID of the payment card to use for translation orders. If not provided, the team credit will be used.
4833
+ * Username for basic HTTP authentication.
3296
4834
  */
3297
- cardId: string;
4835
+ username: string;
4836
+ }
4837
+ export interface ProjectConnectorsOpentelemetryAuthenticationOauth2ClientCredentials {
3298
4838
  /**
3299
- * A description of what your connector is used for.
4839
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
3300
4840
  */
3301
- description: string;
3302
- id: string;
4841
+ authStyle: string;
3303
4842
  /**
3304
- * A custom name for your connector.
4843
+ * The token endpoint URL used to request an access token.
3305
4844
  */
3306
- name: string;
4845
+ authUrl: string;
3307
4846
  /**
3308
- * Lokalise project ID.
4847
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
3309
4848
  */
3310
- projectId: string;
4849
+ clientId: string;
3311
4850
  /**
3312
- * Lokalise team ID. If not provided, the oldest available team will be used.
4851
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
3313
4852
  */
3314
- teamId: string;
4853
+ clientSecret: string;
3315
4854
  /**
3316
- * The translation provider to use ('gengo', 'google', 'lokalise', 'deepl'), default is 'deepl'.
4855
+ * A space-separated list of OAuth scopes to request when fetching the access token.
3317
4856
  */
3318
- translationProvider: string;
3319
- }
3320
- export interface ProjectConnectorsMparticle {
4857
+ scopes: string;
3321
4858
  /**
3322
- * The mParticle Server to Server Key generated for the Descope service.
4859
+ * Additional headers to include in the token request sent to the token endpoint.
3323
4860
  */
3324
- apiKey: string;
4861
+ tokenRequestHeaders: {
4862
+ [key: string]: string;
4863
+ };
4864
+ }
4865
+ export interface ProjectConnectorsPendo {
3325
4866
  /**
3326
- * The mParticle Server to Server Secret generated for the Descope service.
4867
+ * Whether to enable streaming of audit events.
3327
4868
  */
3328
- apiSecret: string;
4869
+ auditEnabled: boolean;
3329
4870
  /**
3330
- * The base URL of the mParticle API, when using a custom domain in mParticle. default value is https://s2s.mparticle.com/
4871
+ * Specify which events will be sent to the external audit service (including tenant selection).
3331
4872
  */
3332
- baseUrl: string;
4873
+ auditFilters: outputs.ProjectConnectorsPendoAuditFilter[];
3333
4874
  /**
3334
- * The default environment of which connector send data to, either “production” or “development“. default value: production. This field can be overridden per event (see at flows).
4875
+ * The Pendo regional domain to send logs to. Default is the US region, `https://data.pendo.io`. Customers in other regions must set this accordingly.
3335
4876
  */
3336
- defaultEnvironment: string;
4877
+ baseUrl: string;
3337
4878
  /**
3338
4879
  * A description of what your connector is used for.
3339
4880
  */
3340
4881
  description: string;
3341
4882
  id: string;
4883
+ /**
4884
+ * The secret Pendo integration key Descope should use.
4885
+ */
4886
+ integrationKey: string;
4887
+ /**
4888
+ * Whether to mask personally identifiable information in the logs.
4889
+ */
4890
+ maskPii: boolean;
3342
4891
  /**
3343
4892
  * A custom name for your connector.
3344
4893
  */
3345
4894
  name: string;
3346
4895
  /**
3347
- * Whether the connector should send all requests from specific static IPs.
4896
+ * Whether to send troubleshooting events.
3348
4897
  */
3349
- useStaticIps: boolean;
4898
+ troubleshootLogEnabled: boolean;
3350
4899
  }
3351
- export interface ProjectConnectorsNewrelic {
4900
+ export interface ProjectConnectorsPendoAuditFilter {
3352
4901
  /**
3353
- * Ingest License Key of the account you want to report data to.
3354
- */
3355
- apiKey: string;
3356
- /**
3357
- * Whether to enable streaming of audit events.
4902
+ * The field name to filter on (either 'actions' or 'tenants').
3358
4903
  */
3359
- auditEnabled: boolean;
4904
+ key: string;
3360
4905
  /**
3361
- * Specify which events will be sent to the external audit service (including tenant selection).
4906
+ * The filter operation to apply ('includes' or 'excludes').
3362
4907
  */
3363
- auditFilters: outputs.ProjectConnectorsNewrelicAuditFilter[];
4908
+ operator: string;
3364
4909
  /**
3365
- * The New Relic data center the account belongs to. Possible values are: `US`, `EU`, `FedRAMP`. Default is `US`.
4910
+ * The list of values to match against for the filter.
3366
4911
  */
3367
- dataCenter: string;
4912
+ values: string[];
4913
+ }
4914
+ export interface ProjectConnectorsPingDirectory {
3368
4915
  /**
3369
4916
  * A description of what your connector is used for.
3370
4917
  */
3371
4918
  description: string;
3372
- id: string;
3373
4919
  /**
3374
- * Specify a custom prefix for all log fields. The default prefix is `descope.`.
4920
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
3375
4921
  */
3376
- logsPrefix: string;
4922
+ engineId: string;
4923
+ /**
4924
+ * PingDirectory's REST API host.
4925
+ */
4926
+ host: string;
4927
+ id: string;
3377
4928
  /**
3378
4929
  * A custom name for your connector.
3379
4930
  */
3380
4931
  name: string;
3381
4932
  /**
3382
- * Enable this option to use a custom prefix for log fields.
4933
+ * PingDirectory's REST API port.
3383
4934
  */
3384
- overrideLogsPrefix: boolean;
4935
+ port: number;
4936
+ }
4937
+ export interface ProjectConnectorsPostmark {
3385
4938
  /**
3386
- * Whether to send troubleshooting events.
4939
+ * A description of what your connector is used for.
3387
4940
  */
3388
- troubleshootLogEnabled: boolean;
3389
- }
3390
- export interface ProjectConnectorsNewrelicAuditFilter {
4941
+ description: string;
3391
4942
  /**
3392
- * The field name to filter on (either 'actions' or 'tenants').
4943
+ * The email address that will appear in the 'From' field of the sent email
3393
4944
  */
3394
- key: string;
4945
+ emailFrom: string;
4946
+ id: string;
3395
4947
  /**
3396
- * The filter operation to apply ('includes' or 'excludes').
4948
+ * The ID of the message stream to use for the email
3397
4949
  */
3398
- operator: string;
4950
+ messageStreamId: string;
3399
4951
  /**
3400
- * The list of values to match against for the filter.
4952
+ * A custom name for your connector.
3401
4953
  */
3402
- values: string[];
4954
+ name: string;
4955
+ /**
4956
+ * The API token for authenticating with the Postmark server
4957
+ */
4958
+ serverApiToken: string;
3403
4959
  }
3404
4960
  export interface ProjectConnectorsRadar {
3405
4961
  /**
@@ -3460,6 +5016,10 @@ export interface ProjectConnectorsRecaptcha {
3460
5016
  siteKey: string;
3461
5017
  }
3462
5018
  export interface ProjectConnectorsRecaptchaEnterprise {
5019
+ /**
5020
+ * The user-initiated action for this assessment.
5021
+ */
5022
+ action: string;
3463
5023
  /**
3464
5024
  * API key associated with the current project.
3465
5025
  */
@@ -3469,7 +5029,7 @@ export interface ProjectConnectorsRecaptchaEnterprise {
3469
5029
  */
3470
5030
  assessmentScore: number;
3471
5031
  /**
3472
- * Apply a custom url to the reCAPTCHA Enterprise scripts. This is useful when attempting to use reCAPTCHA globally. Defaults to https://www.google.com
5032
+ * The base URL used to load the reCAPTCHA Enterprise scripts. Select recaptcha.net when google.com is unavailable in your users' region. Restricting this to the official Google domains prevents loading scripts from untrusted hosts.
3473
5033
  */
3474
5034
  baseUrl: string;
3475
5035
  /**
@@ -3480,6 +5040,10 @@ export interface ProjectConnectorsRecaptchaEnterprise {
3480
5040
  * A description of what your connector is used for.
3481
5041
  */
3482
5042
  description: string;
5043
+ /**
5044
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5045
+ */
5046
+ engineId: string;
3483
5047
  id: string;
3484
5048
  /**
3485
5049
  * A custom name for your connector.
@@ -3498,6 +5062,37 @@ export interface ProjectConnectorsRecaptchaEnterprise {
3498
5062
  */
3499
5063
  siteKey: string;
3500
5064
  }
5065
+ export interface ProjectConnectorsRecaptchaV2 {
5066
+ /**
5067
+ * When override is enabled, return this score instead of calling Google.
5068
+ */
5069
+ assessmentScore: number;
5070
+ /**
5071
+ * For v2 verification, success maps to risk score 1 and failure to 0. Bot is detected when risk score is below this threshold (default 0.5).
5072
+ */
5073
+ botThreshold: number;
5074
+ /**
5075
+ * A description of what your connector is used for.
5076
+ */
5077
+ description: string;
5078
+ id: string;
5079
+ /**
5080
+ * A custom name for your connector.
5081
+ */
5082
+ name: string;
5083
+ /**
5084
+ * Override the default assessment model. Intended for automated testing only.
5085
+ */
5086
+ overrideAssessment: boolean;
5087
+ /**
5088
+ * The secret key used to verify the user's response with Google siteverify.
5089
+ */
5090
+ secretKey: string;
5091
+ /**
5092
+ * The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
5093
+ */
5094
+ siteKey: string;
5095
+ }
3501
5096
  export interface ProjectConnectorsRekognition {
3502
5097
  /**
3503
5098
  * The AWS access key ID
@@ -3511,6 +5106,10 @@ export interface ProjectConnectorsRekognition {
3511
5106
  * A description of what your connector is used for.
3512
5107
  */
3513
5108
  description: string;
5109
+ /**
5110
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5111
+ */
5112
+ engineId: string;
3514
5113
  id: string;
3515
5114
  /**
3516
5115
  * A custom name for your connector.
@@ -3521,6 +5120,25 @@ export interface ProjectConnectorsRekognition {
3521
5120
  */
3522
5121
  secretAccessKey: string;
3523
5122
  }
5123
+ export interface ProjectConnectorsRndReassigned {
5124
+ /**
5125
+ * Your RND company ID (e.g., C038612852). Retrieve this from your RND account under Account → Company → Company ID.
5126
+ */
5127
+ companyId: string;
5128
+ /**
5129
+ * A description of what your connector is used for.
5130
+ */
5131
+ description: string;
5132
+ id: string;
5133
+ /**
5134
+ * A custom name for your connector.
5135
+ */
5136
+ name: string;
5137
+ /**
5138
+ * Your RND refresh token for authentication. Retrieve this from your RND account under Account → API Credentials.
5139
+ */
5140
+ refreshToken: string;
5141
+ }
3524
5142
  export interface ProjectConnectorsSalesforce {
3525
5143
  /**
3526
5144
  * The Salesforce API base URL.
@@ -3538,6 +5156,10 @@ export interface ProjectConnectorsSalesforce {
3538
5156
  * A description of what your connector is used for.
3539
5157
  */
3540
5158
  description: string;
5159
+ /**
5160
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5161
+ */
5162
+ engineId: string;
3541
5163
  id: string;
3542
5164
  /**
3543
5165
  * A custom name for your connector.
@@ -3546,61 +5168,172 @@ export interface ProjectConnectorsSalesforce {
3546
5168
  /**
3547
5169
  * REST API Version.
3548
5170
  */
3549
- version: string;
3550
- }
3551
- export interface ProjectConnectorsSalesforceMarketingCloud {
5171
+ version: string;
5172
+ }
5173
+ export interface ProjectConnectorsSalesforceMarketingCloud {
5174
+ /**
5175
+ * Account identifier, or MID, of the target business unit.
5176
+ */
5177
+ accountId: string;
5178
+ /**
5179
+ * Client ID issued when you create the API integration in Installed Packages.
5180
+ */
5181
+ clientId: string;
5182
+ /**
5183
+ * Client secret issued when you create the API integration in Installed Packages.
5184
+ */
5185
+ clientSecret: string;
5186
+ /**
5187
+ * A description of what your connector is used for.
5188
+ */
5189
+ description: string;
5190
+ /**
5191
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5192
+ */
5193
+ engineId: string;
5194
+ id: string;
5195
+ /**
5196
+ * A custom name for your connector.
5197
+ */
5198
+ name: string;
5199
+ /**
5200
+ * Space-separated list of data-access permissions for your connector.
5201
+ */
5202
+ scope: string;
5203
+ /**
5204
+ * The Salesforce Marketing Cloud endpoint subdomain.
5205
+ */
5206
+ subdomain: string;
5207
+ }
5208
+ export interface ProjectConnectorsSardine {
5209
+ /**
5210
+ * The base URL for the Sardine API, e.g.: https://api.sandbox.sardine.ai, https://api.sardine.ai, https://api.eu.sardine.ai.
5211
+ */
5212
+ baseUrl: string;
5213
+ /**
5214
+ * The Sardine Client ID.
5215
+ */
5216
+ clientId: string;
5217
+ /**
5218
+ * The Sardine Client Secret.
5219
+ */
5220
+ clientSecret: string;
5221
+ /**
5222
+ * A description of what your connector is used for.
5223
+ */
5224
+ description: string;
5225
+ id: string;
5226
+ /**
5227
+ * A custom name for your connector.
5228
+ */
5229
+ name: string;
5230
+ }
5231
+ export interface ProjectConnectorsScim {
5232
+ /**
5233
+ * Authentication credentials used when sending requests to the SCIM endpoint.
5234
+ */
5235
+ authentication: outputs.ProjectConnectorsScimAuthentication;
5236
+ /**
5237
+ * The base URL of the SCIM v2 endpoint that user provisioning events will be sent to.
5238
+ */
5239
+ baseUrl: string;
5240
+ /**
5241
+ * A description of what your connector is used for.
5242
+ */
5243
+ description: string;
5244
+ /**
5245
+ * Whether to disable this SCIM connector. When disabled, provisioning events will not be sent to the configured endpoint.
5246
+ */
5247
+ disabled: boolean;
5248
+ /**
5249
+ * The ID of the federated SSO application this SCIM connector is associated with.
5250
+ */
5251
+ federatedAppId: string;
5252
+ /**
5253
+ * Custom HTTP headers to send with each provisioning request.
5254
+ */
5255
+ headers: {
5256
+ [key: string]: string;
5257
+ };
5258
+ /**
5259
+ * 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.
5260
+ */
5261
+ hmacSecret: string;
5262
+ id: string;
5263
+ /**
5264
+ * Will ignore certificate errors raised by the client.
5265
+ */
5266
+ insecure: boolean;
5267
+ /**
5268
+ * A custom name for your connector.
5269
+ */
5270
+ name: string;
5271
+ }
5272
+ export interface ProjectConnectorsScimAuthentication {
5273
+ /**
5274
+ * API key authentication configuration.
5275
+ */
5276
+ apiKey: outputs.ProjectConnectorsScimAuthenticationApiKey;
3552
5277
  /**
3553
- * Account identifier, or MID, of the target business unit.
5278
+ * Basic authentication credentials (username and password).
3554
5279
  */
3555
- accountId: string;
5280
+ basic: outputs.ProjectConnectorsScimAuthenticationBasic;
3556
5281
  /**
3557
- * Client ID issued when you create the API integration in Installed Packages.
5282
+ * Bearer token for HTTP authentication.
3558
5283
  */
3559
- clientId: string;
5284
+ bearerToken: string;
3560
5285
  /**
3561
- * Client secret issued when you create the API integration in Installed Packages.
5286
+ * OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
3562
5287
  */
3563
- clientSecret: string;
5288
+ oauth2ClientCredentials: outputs.ProjectConnectorsScimAuthenticationOauth2ClientCredentials;
5289
+ }
5290
+ export interface ProjectConnectorsScimAuthenticationApiKey {
3564
5291
  /**
3565
- * A description of what your connector is used for.
5292
+ * The API key.
3566
5293
  */
3567
- description: string;
3568
- id: string;
5294
+ key: string;
3569
5295
  /**
3570
- * A custom name for your connector.
5296
+ * The API secret.
3571
5297
  */
3572
- name: string;
5298
+ token: string;
5299
+ }
5300
+ export interface ProjectConnectorsScimAuthenticationBasic {
3573
5301
  /**
3574
- * Space-separated list of data-access permissions for your connector.
5302
+ * Password for basic HTTP authentication.
3575
5303
  */
3576
- scope: string;
5304
+ password: string;
3577
5305
  /**
3578
- * The Salesforce Marketing Cloud endpoint subdomain.
5306
+ * Username for basic HTTP authentication.
3579
5307
  */
3580
- subdomain: string;
5308
+ username: string;
3581
5309
  }
3582
- export interface ProjectConnectorsSardine {
5310
+ export interface ProjectConnectorsScimAuthenticationOauth2ClientCredentials {
3583
5311
  /**
3584
- * The base URL for the Sardine API, e.g.: https://api.sandbox.sardine.ai, https://api.sardine.ai, https://api.eu.sardine.ai.
5312
+ * How the client credentials are sent to the token endpoint. Either `header` to send them in the `Authorization` header, or `body` to send them in the request body.
3585
5313
  */
3586
- baseUrl: string;
5314
+ authStyle: string;
3587
5315
  /**
3588
- * The Sardine Client ID.
5316
+ * The token endpoint URL used to request an access token.
5317
+ */
5318
+ authUrl: string;
5319
+ /**
5320
+ * The OAuth 2.0 client ID used to authenticate against the token endpoint.
3589
5321
  */
3590
5322
  clientId: string;
3591
5323
  /**
3592
- * The Sardine Client Secret.
5324
+ * The OAuth 2.0 client secret used to authenticate against the token endpoint.
3593
5325
  */
3594
5326
  clientSecret: string;
3595
5327
  /**
3596
- * A description of what your connector is used for.
5328
+ * A space-separated list of OAuth scopes to request when fetching the access token.
3597
5329
  */
3598
- description: string;
3599
- id: string;
5330
+ scopes: string;
3600
5331
  /**
3601
- * A custom name for your connector.
5332
+ * Additional headers to include in the token request sent to the token endpoint.
3602
5333
  */
3603
- name: string;
5334
+ tokenRequestHeaders: {
5335
+ [key: string]: string;
5336
+ };
3604
5337
  }
3605
5338
  export interface ProjectConnectorsSe {
3606
5339
  /**
@@ -3714,6 +5447,10 @@ export interface ProjectConnectorsSlack {
3714
5447
  * A description of what your connector is used for.
3715
5448
  */
3716
5449
  description: string;
5450
+ /**
5451
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5452
+ */
5453
+ engineId: string;
3717
5454
  id: string;
3718
5455
  /**
3719
5456
  * A custom name for your connector.
@@ -3813,6 +5550,10 @@ export interface ProjectConnectorsSn {
3813
5550
  * AWS Access key ID.
3814
5551
  */
3815
5552
  accessKeyId: string;
5553
+ /**
5554
+ * The authentication type to use.
5555
+ */
5556
+ authType: string;
3816
5557
  /**
3817
5558
  * A description of what your connector is used for.
3818
5559
  */
@@ -3825,6 +5566,10 @@ export interface ProjectConnectorsSn {
3825
5566
  * The entity ID or principal entity (PE) ID for sending text messages to recipients in India.
3826
5567
  */
3827
5568
  entityId: string;
5569
+ /**
5570
+ * The external ID to use when assuming the role.
5571
+ */
5572
+ externalId: string;
3828
5573
  id: string;
3829
5574
  /**
3830
5575
  * A custom name for your connector.
@@ -3844,6 +5589,10 @@ export interface ProjectConnectorsSn {
3844
5589
  * AWS region to send requests to (e.g. `us-west-2`).
3845
5590
  */
3846
5591
  region: string;
5592
+ /**
5593
+ * The Amazon Resource Name (ARN) of the role to assume.
5594
+ */
5595
+ roleArn: string;
3847
5596
  /**
3848
5597
  * AWS Secret Access Key.
3849
5598
  */
@@ -3857,6 +5606,171 @@ export interface ProjectConnectorsSn {
3857
5606
  */
3858
5607
  templateId: string;
3859
5608
  }
5609
+ export interface ProjectConnectorsSnowflake {
5610
+ /**
5611
+ * A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges.
5612
+ */
5613
+ apiKey: string;
5614
+ /**
5615
+ * Whether to enable streaming of audit events.
5616
+ */
5617
+ auditEnabled: boolean;
5618
+ /**
5619
+ * Specify which events will be sent to the external audit service (including tenant selection).
5620
+ */
5621
+ auditFilters: outputs.ProjectConnectorsSnowflakeAuditFilter[];
5622
+ /**
5623
+ * The table to write audit events to. Defaults to `DESCOPE_AUDIT_LOGS`.
5624
+ */
5625
+ auditTable: string;
5626
+ /**
5627
+ * The Snowflake database to use. Defaults to `DESCOPE_EXPORT_DB`.
5628
+ */
5629
+ database: string;
5630
+ /**
5631
+ * A description of what your connector is used for.
5632
+ */
5633
+ description: string;
5634
+ /**
5635
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5636
+ */
5637
+ engineId: string;
5638
+ id: string;
5639
+ /**
5640
+ * Whether to mask personally identifiable information in the logs.
5641
+ */
5642
+ maskPii: boolean;
5643
+ /**
5644
+ * The minimum time between writes to Snowflake, in minutes. When set, events are accumulated and written in a single batch at most once per interval, which lets the warehouse auto-suspend between writes and reduces cost. Set to 0 (or leave empty) to write events according to the default Descope cycle.
5645
+ */
5646
+ minFlushIntervalMinutes: number;
5647
+ /**
5648
+ * A custom name for your connector.
5649
+ */
5650
+ name: string;
5651
+ /**
5652
+ * The schema within the database. Defaults to `PUBLIC`.
5653
+ */
5654
+ schema: string;
5655
+ /**
5656
+ * Your Snowflake account URL, e.g. `https://<org>-<account>.snowflakecomputing.com`.
5657
+ */
5658
+ site: string;
5659
+ /**
5660
+ * Whether to send troubleshooting events.
5661
+ */
5662
+ troubleshootLogEnabled: boolean;
5663
+ /**
5664
+ * The Snowflake warehouse to use. Defaults to `COMPUTE_WH`.
5665
+ */
5666
+ warehouse: string;
5667
+ }
5668
+ export interface ProjectConnectorsSnowflakeAuditFilter {
5669
+ /**
5670
+ * The field name to filter on (either 'actions' or 'tenants').
5671
+ */
5672
+ key: string;
5673
+ /**
5674
+ * The filter operation to apply ('includes' or 'excludes').
5675
+ */
5676
+ operator: string;
5677
+ /**
5678
+ * The list of values to match against for the filter.
5679
+ */
5680
+ values: string[];
5681
+ }
5682
+ export interface ProjectConnectorsSplunk {
5683
+ /**
5684
+ * Whether to enable streaming of audit events.
5685
+ */
5686
+ auditEnabled: boolean;
5687
+ /**
5688
+ * Specify which events will be sent to the external audit service (including tenant selection).
5689
+ */
5690
+ auditFilters: outputs.ProjectConnectorsSplunkAuditFilter[];
5691
+ /**
5692
+ * A description of what your connector is used for.
5693
+ */
5694
+ description: string;
5695
+ /**
5696
+ * The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
5697
+ */
5698
+ engineId: string;
5699
+ /**
5700
+ * An HTTP Event Collector token configured on your Splunk project.
5701
+ */
5702
+ hecToken: string;
5703
+ /**
5704
+ * The URL to be used accessing your Splunk system, including the appropriate port
5705
+ */
5706
+ hecUrl: string;
5707
+ id: string;
5708
+ /**
5709
+ * An optional index to use for all sent events
5710
+ */
5711
+ index: string;
5712
+ /**
5713
+ * A custom name for your connector.
5714
+ */
5715
+ name: string;
5716
+ /**
5717
+ * Whether to send troubleshooting events.
5718
+ */
5719
+ troubleshootLogEnabled: boolean;
5720
+ }
5721
+ export interface ProjectConnectorsSplunkAuditFilter {
5722
+ /**
5723
+ * The field name to filter on (either 'actions' or 'tenants').
5724
+ */
5725
+ key: string;
5726
+ /**
5727
+ * The filter operation to apply ('includes' or 'excludes').
5728
+ */
5729
+ operator: string;
5730
+ /**
5731
+ * The list of values to match against for the filter.
5732
+ */
5733
+ values: string[];
5734
+ }
5735
+ export interface ProjectConnectorsSql {
5736
+ /**
5737
+ * The database name.
5738
+ */
5739
+ databaseName: string;
5740
+ /**
5741
+ * A description of what your connector is used for.
5742
+ */
5743
+ description: string;
5744
+ /**
5745
+ * The database engine type.
5746
+ */
5747
+ engineName: string;
5748
+ /**
5749
+ * The database host.
5750
+ */
5751
+ host: string;
5752
+ id: string;
5753
+ /**
5754
+ * A custom name for your connector.
5755
+ */
5756
+ name: string;
5757
+ /**
5758
+ * The database password.
5759
+ */
5760
+ password: string;
5761
+ /**
5762
+ * The database port. If not specified, the default port for the selected engine will be used.
5763
+ */
5764
+ port: number;
5765
+ /**
5766
+ * The Oracle service name (required for Oracle only).
5767
+ */
5768
+ serviceName: string;
5769
+ /**
5770
+ * The database username.
5771
+ */
5772
+ username: string;
5773
+ }
3860
5774
  export interface ProjectConnectorsSumologic {
3861
5775
  /**
3862
5776
  * Whether to enable streaming of audit events.
@@ -4104,6 +6018,60 @@ export interface ProjectConnectorsTwilioVerifyAuthentication {
4104
6018
  */
4105
6019
  authToken: string;
4106
6020
  }
6021
+ export interface ProjectConnectorsUnibeam {
6022
+ /**
6023
+ * Unibeam API base URL.
6024
+ */
6025
+ baseUrl: string;
6026
+ /**
6027
+ * OAuth2 client ID for authentication.
6028
+ */
6029
+ clientId: string;
6030
+ /**
6031
+ * OAuth2 client secret for authentication.
6032
+ */
6033
+ clientSecret: string;
6034
+ /**
6035
+ * Your Unibeam customer ID.
6036
+ */
6037
+ customerId: string;
6038
+ /**
6039
+ * Default message to display when no message is provided in the command.
6040
+ */
6041
+ defaultMessage: string;
6042
+ /**
6043
+ * A description of what your connector is used for.
6044
+ */
6045
+ description: string;
6046
+ /**
6047
+ * HMAC secret supplied by Unibeam for securing communications.
6048
+ */
6049
+ hmacSecret: string;
6050
+ id: string;
6051
+ /**
6052
+ * A custom name for your connector.
6053
+ */
6054
+ name: string;
6055
+ }
6056
+ export interface ProjectConnectorsZerobounce {
6057
+ /**
6058
+ * The ZeroBounce API key.
6059
+ */
6060
+ apiKey: string;
6061
+ /**
6062
+ * A description of what your connector is used for.
6063
+ */
6064
+ description: string;
6065
+ id: string;
6066
+ /**
6067
+ * A custom name for your connector.
6068
+ */
6069
+ name: string;
6070
+ /**
6071
+ * ZeroBounce platform region.
6072
+ */
6073
+ region: string;
6074
+ }
4107
6075
  export interface ProjectFlows {
4108
6076
  /**
4109
6077
  * The JSON data defining the authentication flow configuration, including metadata, screens, contents, and references.
@@ -4192,6 +6160,10 @@ export interface ProjectJwtTemplates {
4192
6160
  userTemplates: outputs.ProjectJwtTemplatesUserTemplate[];
4193
6161
  }
4194
6162
  export interface ProjectJwtTemplatesAccessKeyTemplate {
6163
+ /**
6164
+ * When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
6165
+ */
6166
+ addJtiClaim: boolean;
4195
6167
  /**
4196
6168
  * The authorization claims format - `default`, `tenantOnly` or `none`. Read more about schema types [here](https://docs.descope.com/project-settings/jwt-templates).
4197
6169
  */
@@ -4216,17 +6188,29 @@ export interface ProjectJwtTemplatesAccessKeyTemplate {
4216
6188
  * Whether to enforce that the JWT issuer matches the project configuration.
4217
6189
  */
4218
6190
  enforceIssuer: boolean;
6191
+ /**
6192
+ * When enabled, permissions will not be included in the JWT token.
6193
+ */
6194
+ excludePermissionClaim: boolean;
4219
6195
  id: string;
4220
6196
  /**
4221
6197
  * Name of the JWT Template.
4222
6198
  */
4223
6199
  name: string;
6200
+ /**
6201
+ * Switching on will allow you to add a custom subject claim to the JWT. A default new `dsub` claim will be added with the user ID.
6202
+ */
6203
+ overrideSubjectClaim: boolean;
4224
6204
  /**
4225
6205
  * The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a `string` value.
4226
6206
  */
4227
6207
  template: string;
4228
6208
  }
4229
6209
  export interface ProjectJwtTemplatesUserTemplate {
6210
+ /**
6211
+ * When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
6212
+ */
6213
+ addJtiClaim: boolean;
4230
6214
  /**
4231
6215
  * The authorization claims format - `default`, `tenantOnly` or `none`. Read more about schema types [here](https://docs.descope.com/project-settings/jwt-templates).
4232
6216
  */
@@ -4251,11 +6235,19 @@ export interface ProjectJwtTemplatesUserTemplate {
4251
6235
  * Whether to enforce that the JWT issuer matches the project configuration.
4252
6236
  */
4253
6237
  enforceIssuer: boolean;
6238
+ /**
6239
+ * When enabled, permissions will not be included in the JWT token.
6240
+ */
6241
+ excludePermissionClaim: boolean;
4254
6242
  id: string;
4255
6243
  /**
4256
6244
  * Name of the JWT Template.
4257
6245
  */
4258
6246
  name: string;
6247
+ /**
6248
+ * Switching on will allow you to add a custom subject claim to the JWT. A default new `dsub` claim will be added with the user ID.
6249
+ */
6250
+ overrideSubjectClaim: boolean;
4259
6251
  /**
4260
6252
  * The JSON template defining the structure and claims of the JWT token. This is expected to be a valid JSON object given as a `string` value.
4261
6253
  */
@@ -4289,6 +6281,10 @@ export interface ProjectProjectSettings {
4289
6281
  * The expiry time for access key session tokens. Use values such as "10 minutes", "4 hours", etc. The value needs to be at least 3 minutes and can't be longer than 4 weeks.
4290
6282
  */
4291
6283
  accessKeySessionTokenExpiration: string;
6284
+ /**
6285
+ * When enabled, Descope-hosted flows can be displayed within an iframe on your website. This modifies the security headers that typically prevent the page from being embedded.
6286
+ */
6287
+ allowAuthHostingIframeEmbedding: boolean;
4292
6288
  /**
4293
6289
  * The URL which your application resides on.
4294
6290
  */
@@ -4357,6 +6353,10 @@ export interface ProjectProjectSettings {
4357
6353
  * The expiry time for the step up token, after which it will not be valid and the user will automatically go back to the session token.
4358
6354
  */
4359
6355
  stepUpTokenExpiration: string;
6356
+ /**
6357
+ * When enabled, users are completely isolated per tenant. The same login ID in Tenant A and Tenant B will be treated as separate identities with isolated credentials, sessions, and MFA state.
6358
+ */
6359
+ tenantUserIsolation: boolean;
4360
6360
  /**
4361
6361
  * Define a regular expression so that whenever a user is created with a matching login ID it will automatically be marked as a test user.
4362
6362
  */
@@ -4379,6 +6379,10 @@ export interface ProjectProjectSettings {
4379
6379
  userJwtTemplate: string;
4380
6380
  }
4381
6381
  export interface ProjectProjectSettingsSessionMigration {
6382
+ /**
6383
+ * An API token for the vendor, required when `vendor` is set to `okta`.
6384
+ */
6385
+ apiToken: string;
4382
6386
  /**
4383
6387
  * The audience value if needed by the vendor.
4384
6388
  */
@@ -4399,11 +6403,29 @@ export interface ProjectProjectSettingsSessionMigration {
4399
6403
  * A set of attributes from the vendor's user that should be used to match with the Descope user's login ID.
4400
6404
  */
4401
6405
  loginidMatchedAttributes: string[];
6406
+ /**
6407
+ * A list of attribute mappings from the external vendor's user to Descope user attributes.
6408
+ */
6409
+ userMappings: outputs.ProjectProjectSettingsSessionMigrationUserMapping[];
6410
+ /**
6411
+ * The type of user synchronization to perform. Valid values are `matchOnly` (match existing users only) and `jit` (just-in-time provisioning).
6412
+ */
6413
+ userSyncType: string;
4402
6414
  /**
4403
6415
  * The name of the vendor the sessions are migrated from, in all lowercase.
4404
6416
  */
4405
6417
  vendor: string;
4406
6418
  }
6419
+ export interface ProjectProjectSettingsSessionMigrationUserMapping {
6420
+ /**
6421
+ * The Descope user attribute to map the external key to.
6422
+ */
6423
+ descopeKey: string;
6424
+ /**
6425
+ * The attribute key in the external vendor's user object.
6426
+ */
6427
+ externalKey: string;
6428
+ }
4407
6429
  export interface ProjectStyles {
4408
6430
  /**
4409
6431
  * The JSON data defining the visual styling and theme configuration used for authentication, widgets, etc.
@@ -4416,3 +6438,4 @@ export interface ProjectWidgets {
4416
6438
  */
4417
6439
  data: string;
4418
6440
  }
6441
+ //# sourceMappingURL=output.d.ts.map