@descope/pulumi-descope 0.3.4 → 0.3.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accessKey.d.ts +197 -0
- package/accessKey.d.ts.map +1 -0
- package/accessKey.js +105 -0
- package/accessKey.js.map +1 -0
- package/config/index.d.ts +1 -0
- package/config/index.d.ts.map +1 -0
- package/config/vars.d.ts +1 -0
- package/config/vars.d.ts.map +1 -0
- package/config/vars.js +24 -1
- package/config/vars.js.map +1 -1
- package/descoper.d.ts +178 -0
- package/descoper.d.ts.map +1 -0
- package/descoper.js +175 -0
- package/descoper.js.map +1 -0
- package/engine.d.ts +77 -0
- package/engine.d.ts.map +1 -0
- package/engine.js +83 -0
- package/engine.js.map +1 -0
- package/inboundApp.d.ts +243 -0
- package/inboundApp.d.ts.map +1 -0
- package/inboundApp.js +109 -0
- package/inboundApp.js.map +1 -0
- package/index.d.ts +16 -0
- package/index.d.ts.map +1 -0
- package/index.js +42 -5
- package/index.js.map +1 -1
- package/managementKey.d.ts +189 -0
- package/managementKey.d.ts.map +1 -0
- package/managementKey.js +159 -0
- package/managementKey.js.map +1 -0
- package/package.json +4 -4
- package/project.d.ts +309 -30
- package/project.d.ts.map +1 -0
- package/project.js +295 -4
- package/project.js.map +1 -1
- package/provider.d.ts +4 -3
- package/provider.d.ts.map +1 -0
- package/provider.js +27 -4
- package/provider.js.map +1 -1
- package/types/index.d.ts +1 -0
- package/types/index.d.ts.map +1 -0
- package/types/index.js +25 -2
- package/types/index.js.map +1 -1
- package/types/input.d.ts +2541 -853
- package/types/input.d.ts.map +1 -0
- package/types/output.d.ts +1742 -54
- package/types/output.d.ts.map +1 -0
- package/utilities.d.ts +1 -0
- package/utilities.d.ts.map +1 -0
- package/utilities.js +24 -1
- 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,52 @@ 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;
|
|
13
207
|
/**
|
|
14
208
|
* A list of supported claims. e.g. `sub`, `email`, `exp`.
|
|
15
209
|
*/
|
|
16
210
|
claims: string[];
|
|
211
|
+
/**
|
|
212
|
+
* Disables the `clientCredentials` grant type for this application.
|
|
213
|
+
*/
|
|
214
|
+
clientCredentialsDisabled: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* 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.
|
|
217
|
+
*/
|
|
218
|
+
clientId: string;
|
|
219
|
+
/**
|
|
220
|
+
* 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.
|
|
221
|
+
*/
|
|
222
|
+
clientSecret: string;
|
|
223
|
+
/**
|
|
224
|
+
* OAuth client confidentiality. One of `""` (default — legacy access-key authentication), `"confidential"` (a dedicated client secret is generated for the app), or `"public"`.
|
|
225
|
+
*/
|
|
226
|
+
clientType: string;
|
|
227
|
+
/**
|
|
228
|
+
* Controls the default `aud` claim of tokens issued for this application. One of `"projectId"` (the project ID only), `"clientId"` (the dedicated client ID only), or `""` (default — both). Only applies to modern apps that set a `clientType`; legacy apps always use the project ID, so the empty default leaves their behavior unchanged.
|
|
229
|
+
*/
|
|
230
|
+
defaultAudience: string;
|
|
17
231
|
/**
|
|
18
232
|
* A description for the OIDC application.
|
|
19
233
|
*/
|
|
20
234
|
description: string;
|
|
235
|
+
/**
|
|
236
|
+
* Disables the `urn:ietf:params:oauth:grant-type:device_code` grant type for this application.
|
|
237
|
+
*/
|
|
238
|
+
deviceCodeDisabled: boolean;
|
|
21
239
|
/**
|
|
22
240
|
* Whether the application should be enabled or disabled.
|
|
23
241
|
*/
|
|
@@ -26,10 +244,18 @@ export interface ProjectApplicationsOidcApplication {
|
|
|
26
244
|
* 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
245
|
*/
|
|
28
246
|
forceAuthentication: boolean;
|
|
247
|
+
/**
|
|
248
|
+
* 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.
|
|
249
|
+
*/
|
|
250
|
+
forcePkce: boolean;
|
|
29
251
|
/**
|
|
30
252
|
* An optional identifier for the OIDC application.
|
|
31
253
|
*/
|
|
32
254
|
id: string;
|
|
255
|
+
/**
|
|
256
|
+
* Disables the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant type for this application.
|
|
257
|
+
*/
|
|
258
|
+
jwtBearerDisabled: boolean;
|
|
33
259
|
/**
|
|
34
260
|
* The Flow Hosting URL. Read more about using this parameter with custom domain [here](https://docs.descope.com/sso-integrations/applications/saml-apps).
|
|
35
261
|
*/
|
|
@@ -42,6 +268,24 @@ export interface ProjectApplicationsOidcApplication {
|
|
|
42
268
|
* A name for the OIDC application.
|
|
43
269
|
*/
|
|
44
270
|
name: string;
|
|
271
|
+
permissions: outputs.ProjectApplicationsOidcApplicationPermission[];
|
|
272
|
+
/**
|
|
273
|
+
* Disables the `refreshToken` grant type for this application.
|
|
274
|
+
*/
|
|
275
|
+
refreshTokenDisabled: boolean;
|
|
276
|
+
roles: outputs.ProjectApplicationsOidcApplicationRole[];
|
|
277
|
+
}
|
|
278
|
+
export interface ProjectApplicationsOidcApplicationPermission {
|
|
279
|
+
description: string;
|
|
280
|
+
id: string;
|
|
281
|
+
name: string;
|
|
282
|
+
}
|
|
283
|
+
export interface ProjectApplicationsOidcApplicationRole {
|
|
284
|
+
description: string;
|
|
285
|
+
id: string;
|
|
286
|
+
name: string;
|
|
287
|
+
permissions: string[];
|
|
288
|
+
roleMappings: string[];
|
|
45
289
|
}
|
|
46
290
|
export interface ProjectApplicationsSamlApplication {
|
|
47
291
|
/**
|
|
@@ -56,6 +300,10 @@ export interface ProjectApplicationsSamlApplication {
|
|
|
56
300
|
* 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
301
|
*/
|
|
58
302
|
defaultRelayState: string;
|
|
303
|
+
/**
|
|
304
|
+
* 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.
|
|
305
|
+
*/
|
|
306
|
+
defaultSignatureAlgorithm: string;
|
|
59
307
|
/**
|
|
60
308
|
* A description for the SAML application.
|
|
61
309
|
*/
|
|
@@ -92,6 +340,8 @@ export interface ProjectApplicationsSamlApplication {
|
|
|
92
340
|
* A name for the SAML application.
|
|
93
341
|
*/
|
|
94
342
|
name: string;
|
|
343
|
+
permissions: outputs.ProjectApplicationsSamlApplicationPermission[];
|
|
344
|
+
roles: outputs.ProjectApplicationsSamlApplicationRole[];
|
|
95
345
|
/**
|
|
96
346
|
* 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
347
|
*/
|
|
@@ -131,16 +381,178 @@ export interface ProjectApplicationsSamlApplicationManualConfiguration {
|
|
|
131
381
|
*/
|
|
132
382
|
entityId: string;
|
|
133
383
|
}
|
|
384
|
+
export interface ProjectApplicationsSamlApplicationPermission {
|
|
385
|
+
description: string;
|
|
386
|
+
id: string;
|
|
387
|
+
name: string;
|
|
388
|
+
}
|
|
389
|
+
export interface ProjectApplicationsSamlApplicationRole {
|
|
390
|
+
description: string;
|
|
391
|
+
id: string;
|
|
392
|
+
name: string;
|
|
393
|
+
permissions: string[];
|
|
394
|
+
roleMappings: string[];
|
|
395
|
+
}
|
|
396
|
+
export interface ProjectApplicationsWsfedApplication {
|
|
397
|
+
/**
|
|
398
|
+
* A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
|
|
399
|
+
*/
|
|
400
|
+
attributeMappings: outputs.ProjectApplicationsWsfedApplicationAttributeMapping[];
|
|
401
|
+
/**
|
|
402
|
+
* A description for the WS-Fed application.
|
|
403
|
+
*/
|
|
404
|
+
description: string;
|
|
405
|
+
/**
|
|
406
|
+
* Whether the application should be enabled or disabled.
|
|
407
|
+
*/
|
|
408
|
+
disabled: boolean;
|
|
409
|
+
/**
|
|
410
|
+
* The URL to redirect to when an error occurs.
|
|
411
|
+
*/
|
|
412
|
+
errorRedirectUrl: string;
|
|
413
|
+
/**
|
|
414
|
+
* 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.
|
|
415
|
+
*/
|
|
416
|
+
forceAuthentication: boolean;
|
|
417
|
+
/**
|
|
418
|
+
* A list of group mappings from Descope roles to WS-Fed groups.
|
|
419
|
+
*/
|
|
420
|
+
groupsMappings: outputs.ProjectApplicationsWsfedApplicationGroupsMapping[];
|
|
421
|
+
/**
|
|
422
|
+
* An optional identifier for the WS-Fed application.
|
|
423
|
+
*/
|
|
424
|
+
id: string;
|
|
425
|
+
/**
|
|
426
|
+
* The Flow Hosting URL.
|
|
427
|
+
*/
|
|
428
|
+
loginPageUrl: string;
|
|
429
|
+
/**
|
|
430
|
+
* A logo for the WS-Fed application. Should be a hosted image URL.
|
|
431
|
+
*/
|
|
432
|
+
logo: string;
|
|
433
|
+
/**
|
|
434
|
+
* The URL to redirect to after logout.
|
|
435
|
+
*/
|
|
436
|
+
logoutRedirectUrl: string;
|
|
437
|
+
/**
|
|
438
|
+
* A name for the WS-Fed application.
|
|
439
|
+
*/
|
|
440
|
+
name: string;
|
|
441
|
+
permissions: outputs.ProjectApplicationsWsfedApplicationPermission[];
|
|
442
|
+
/**
|
|
443
|
+
* The WS-Fed realm identifier for the application.
|
|
444
|
+
*/
|
|
445
|
+
realm: string;
|
|
446
|
+
/**
|
|
447
|
+
* 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.
|
|
448
|
+
*/
|
|
449
|
+
replyAllowedCallbackUrls: string[];
|
|
450
|
+
/**
|
|
451
|
+
* The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no `wreply` is supplied by the RP.
|
|
452
|
+
*/
|
|
453
|
+
replyUrl: string;
|
|
454
|
+
roles: outputs.ProjectApplicationsWsfedApplicationRole[];
|
|
455
|
+
}
|
|
456
|
+
export interface ProjectApplicationsWsfedApplicationAttributeMapping {
|
|
457
|
+
/**
|
|
458
|
+
* The name of the attribute.
|
|
459
|
+
*/
|
|
460
|
+
name: string;
|
|
461
|
+
/**
|
|
462
|
+
* The value of the attribute.
|
|
463
|
+
*/
|
|
464
|
+
value: string;
|
|
465
|
+
}
|
|
466
|
+
export interface ProjectApplicationsWsfedApplicationGroupsMapping {
|
|
467
|
+
/**
|
|
468
|
+
* The filter type for the groups mapping.
|
|
469
|
+
*/
|
|
470
|
+
filterType: string;
|
|
471
|
+
/**
|
|
472
|
+
* The name of the groups mapping.
|
|
473
|
+
*/
|
|
474
|
+
name: string;
|
|
475
|
+
/**
|
|
476
|
+
* The `RoleGroupMapping` object. A list of roles mapped to this group.
|
|
477
|
+
*/
|
|
478
|
+
roles: outputs.ProjectApplicationsWsfedApplicationGroupsMappingRole[];
|
|
479
|
+
/**
|
|
480
|
+
* The type of the groups mapping.
|
|
481
|
+
*/
|
|
482
|
+
type: string;
|
|
483
|
+
/**
|
|
484
|
+
* The value of the groups mapping.
|
|
485
|
+
*/
|
|
486
|
+
value: string;
|
|
487
|
+
}
|
|
488
|
+
export interface ProjectApplicationsWsfedApplicationGroupsMappingRole {
|
|
489
|
+
/**
|
|
490
|
+
* The identifier of the role.
|
|
491
|
+
*/
|
|
492
|
+
id: string;
|
|
493
|
+
/**
|
|
494
|
+
* The name of the role.
|
|
495
|
+
*/
|
|
496
|
+
name: string;
|
|
497
|
+
}
|
|
498
|
+
export interface ProjectApplicationsWsfedApplicationPermission {
|
|
499
|
+
description: string;
|
|
500
|
+
id: string;
|
|
501
|
+
name: string;
|
|
502
|
+
}
|
|
503
|
+
export interface ProjectApplicationsWsfedApplicationRole {
|
|
504
|
+
description: string;
|
|
505
|
+
id: string;
|
|
506
|
+
name: string;
|
|
507
|
+
permissions: string[];
|
|
508
|
+
roleMappings: string[];
|
|
509
|
+
}
|
|
134
510
|
export interface ProjectAttributes {
|
|
135
511
|
/**
|
|
136
|
-
* A list of
|
|
512
|
+
* A list of custom attributes for storing additional details about each access key in the project.
|
|
513
|
+
*/
|
|
514
|
+
accessKeys: outputs.ProjectAttributesAccessKey[];
|
|
515
|
+
/**
|
|
516
|
+
* A list of custom attributes for storing additional details about each tenant in the project.
|
|
137
517
|
*/
|
|
138
518
|
tenants: outputs.ProjectAttributesTenant[];
|
|
139
519
|
/**
|
|
140
|
-
* A list of
|
|
520
|
+
* A list of custom attributes for storing additional details about each user in the project.
|
|
141
521
|
*/
|
|
142
522
|
users: outputs.ProjectAttributesUser[];
|
|
143
523
|
}
|
|
524
|
+
export interface ProjectAttributesAccessKey {
|
|
525
|
+
/**
|
|
526
|
+
* 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`.
|
|
527
|
+
*/
|
|
528
|
+
id: string;
|
|
529
|
+
/**
|
|
530
|
+
* The name of the attribute. This value is called `Display Name` in the Descope console.
|
|
531
|
+
*/
|
|
532
|
+
name: string;
|
|
533
|
+
/**
|
|
534
|
+
* When the attribute type is "multiselect". A list of options to choose from.
|
|
535
|
+
*/
|
|
536
|
+
selectOptions: string[];
|
|
537
|
+
/**
|
|
538
|
+
* The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date".
|
|
539
|
+
*/
|
|
540
|
+
type: string;
|
|
541
|
+
/**
|
|
542
|
+
* Determines the permissions access key are required to have to access this attribute in the access key management widget.
|
|
543
|
+
*/
|
|
544
|
+
widgetAuthorization: outputs.ProjectAttributesAccessKeyWidgetAuthorization;
|
|
545
|
+
}
|
|
546
|
+
export interface ProjectAttributesAccessKeyWidgetAuthorization {
|
|
547
|
+
/**
|
|
548
|
+
* The permissions users are required to have to edit this attribute in the access key management widget.
|
|
549
|
+
*/
|
|
550
|
+
editPermissions: string[];
|
|
551
|
+
/**
|
|
552
|
+
* The permissions users are required to have to view this attribute in the access key management widget.
|
|
553
|
+
*/
|
|
554
|
+
viewPermissions: string[];
|
|
555
|
+
}
|
|
144
556
|
export interface ProjectAttributesTenant {
|
|
145
557
|
/**
|
|
146
558
|
* Determines the required permissions for this tenant.
|
|
@@ -1897,23 +2309,47 @@ export interface ProjectAuthenticationOtpVoiceServiceTemplate {
|
|
|
1897
2309
|
}
|
|
1898
2310
|
export interface ProjectAuthenticationPasskeys {
|
|
1899
2311
|
/**
|
|
1900
|
-
*
|
|
2312
|
+
* 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.
|
|
2313
|
+
*/
|
|
2314
|
+
androidFingerprints: string[];
|
|
2315
|
+
/**
|
|
2316
|
+
* 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
2317
|
*/
|
|
1902
2318
|
disabled: boolean;
|
|
2319
|
+
/**
|
|
2320
|
+
* 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.
|
|
2321
|
+
*/
|
|
2322
|
+
displayName: string;
|
|
1903
2323
|
/**
|
|
1904
2324
|
* Passkeys will be usable in the following domain and all its subdomains.
|
|
1905
2325
|
*/
|
|
1906
2326
|
topLevelDomain: string;
|
|
1907
2327
|
}
|
|
1908
2328
|
export interface ProjectAuthenticationPassword {
|
|
2329
|
+
/**
|
|
2330
|
+
* Whether passwords must contain at least one letter, either uppercase or lowercase.
|
|
2331
|
+
*/
|
|
2332
|
+
anyLetter: boolean;
|
|
1909
2333
|
/**
|
|
1910
2334
|
* 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
2335
|
*/
|
|
1912
2336
|
disabled: boolean;
|
|
2337
|
+
/**
|
|
2338
|
+
* 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.
|
|
2339
|
+
*/
|
|
2340
|
+
disallowEmailMatch: boolean;
|
|
2341
|
+
/**
|
|
2342
|
+
* 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).
|
|
2343
|
+
*/
|
|
2344
|
+
disallowedCharacters: string;
|
|
1913
2345
|
/**
|
|
1914
2346
|
* Settings related to sending password reset emails as part of the password feature.
|
|
1915
2347
|
*/
|
|
1916
2348
|
emailService: outputs.ProjectAuthenticationPasswordEmailService;
|
|
2349
|
+
/**
|
|
2350
|
+
* Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
|
|
2351
|
+
*/
|
|
2352
|
+
enforceStrength: string;
|
|
1917
2353
|
/**
|
|
1918
2354
|
* Whether users are required to change their password periodically.
|
|
1919
2355
|
*/
|
|
@@ -2021,10 +2457,34 @@ export interface ProjectAuthenticationSso {
|
|
|
2021
2457
|
* Whether to allow overriding user's roles with SSO related roles.
|
|
2022
2458
|
*/
|
|
2023
2459
|
allowOverrideRoles: boolean;
|
|
2460
|
+
/**
|
|
2461
|
+
* Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
|
|
2462
|
+
*/
|
|
2463
|
+
blockIfEmailDomainMismatch: boolean;
|
|
2024
2464
|
/**
|
|
2025
2465
|
* 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
2466
|
*/
|
|
2027
2467
|
disabled: boolean;
|
|
2468
|
+
/**
|
|
2469
|
+
* Settings related to sending SSO invite emails as part of the SSO feature.
|
|
2470
|
+
*/
|
|
2471
|
+
emailService: outputs.ProjectAuthenticationSsoEmailService;
|
|
2472
|
+
/**
|
|
2473
|
+
* Whether to enable groups priority.
|
|
2474
|
+
*/
|
|
2475
|
+
groupsPriority: boolean;
|
|
2476
|
+
/**
|
|
2477
|
+
* Mapping to attributes not specified in `mandatoryUserAttributes` is not allowed.
|
|
2478
|
+
*/
|
|
2479
|
+
limitMappingToMandatoryAttributes: boolean;
|
|
2480
|
+
/**
|
|
2481
|
+
* Define the required Descope attributes that must be populated when receiving SSO information.
|
|
2482
|
+
*/
|
|
2483
|
+
mandatoryUserAttributes: outputs.ProjectAuthenticationSsoMandatoryUserAttribute[];
|
|
2484
|
+
/**
|
|
2485
|
+
* Whether to mark the user's email as unverified when logging in via SSO.
|
|
2486
|
+
*/
|
|
2487
|
+
markEmailAsUnverified: boolean;
|
|
2028
2488
|
/**
|
|
2029
2489
|
* Whether to merge existing user accounts with new ones created through SSO authentication.
|
|
2030
2490
|
*/
|
|
@@ -2033,11 +2493,66 @@ export interface ProjectAuthenticationSso {
|
|
|
2033
2493
|
* 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
2494
|
*/
|
|
2035
2495
|
redirectUrl: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* When configuring SSO the groups attribute name must be specified.
|
|
2498
|
+
*/
|
|
2499
|
+
requireGroupsAttributeName: boolean;
|
|
2500
|
+
/**
|
|
2501
|
+
* When configuring SSO an SSO domain must be specified.
|
|
2502
|
+
*/
|
|
2503
|
+
requireSsoDomains: boolean;
|
|
2036
2504
|
/**
|
|
2037
2505
|
* Configuration block for the SSO Suite.
|
|
2038
2506
|
*/
|
|
2039
2507
|
ssoSuiteSettings: outputs.ProjectAuthenticationSsoSsoSuiteSettings;
|
|
2040
2508
|
}
|
|
2509
|
+
export interface ProjectAuthenticationSsoEmailService {
|
|
2510
|
+
/**
|
|
2511
|
+
* The name of the email connector to use for sending emails.
|
|
2512
|
+
*/
|
|
2513
|
+
connector: string;
|
|
2514
|
+
/**
|
|
2515
|
+
* A list of email templates for different authentication flows.
|
|
2516
|
+
*/
|
|
2517
|
+
templates: outputs.ProjectAuthenticationSsoEmailServiceTemplate[];
|
|
2518
|
+
}
|
|
2519
|
+
export interface ProjectAuthenticationSsoEmailServiceTemplate {
|
|
2520
|
+
/**
|
|
2521
|
+
* Whether this email template is currently active and in use.
|
|
2522
|
+
*/
|
|
2523
|
+
active: boolean;
|
|
2524
|
+
/**
|
|
2525
|
+
* HTML content of the email message body, required if `usePlainTextBody` isn't set.
|
|
2526
|
+
*/
|
|
2527
|
+
htmlBody: string;
|
|
2528
|
+
id: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* Unique name for this email template.
|
|
2531
|
+
*/
|
|
2532
|
+
name: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Plain text version of the email message body, required if `usePlainTextBody` is set to `true`.
|
|
2535
|
+
*/
|
|
2536
|
+
plainTextBody: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* Subject line of the email message.
|
|
2539
|
+
*/
|
|
2540
|
+
subject: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* Whether to use the plain text body instead of HTML for the email.
|
|
2543
|
+
*/
|
|
2544
|
+
usePlainTextBody: boolean;
|
|
2545
|
+
}
|
|
2546
|
+
export interface ProjectAuthenticationSsoMandatoryUserAttribute {
|
|
2547
|
+
/**
|
|
2548
|
+
* Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
|
|
2549
|
+
*/
|
|
2550
|
+
custom: boolean;
|
|
2551
|
+
/**
|
|
2552
|
+
* The identifier for the attribute. This value is called `Machine Name` in the Descope console.
|
|
2553
|
+
*/
|
|
2554
|
+
id: string;
|
|
2555
|
+
}
|
|
2041
2556
|
export interface ProjectAuthenticationSsoSsoSuiteSettings {
|
|
2042
2557
|
/**
|
|
2043
2558
|
* Setting this to `true` will allow only verified domains to be used.
|
|
@@ -2051,6 +2566,10 @@ export interface ProjectAuthenticationSsoSsoSuiteSettings {
|
|
|
2051
2566
|
* Setting this to `true` will hide the groups mapping configuration section in the SSO Suite interface.
|
|
2052
2567
|
*/
|
|
2053
2568
|
hideGroupsMapping: boolean;
|
|
2569
|
+
/**
|
|
2570
|
+
* Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
|
|
2571
|
+
*/
|
|
2572
|
+
hideJitGuide: boolean;
|
|
2054
2573
|
/**
|
|
2055
2574
|
* Setting this to `true` will hide the OIDC configuration option.
|
|
2056
2575
|
*/
|
|
@@ -2063,10 +2582,18 @@ export interface ProjectAuthenticationSsoSsoSuiteSettings {
|
|
|
2063
2582
|
* Setting this to `true` will hide the SCIM configuration in the SSO Suite interface.
|
|
2064
2583
|
*/
|
|
2065
2584
|
hideScim: boolean;
|
|
2585
|
+
/**
|
|
2586
|
+
* Whether to display the help/support contact link in the SSO Suite UI.
|
|
2587
|
+
*/
|
|
2588
|
+
showHelpContact: boolean;
|
|
2066
2589
|
/**
|
|
2067
2590
|
* 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
2591
|
*/
|
|
2069
2592
|
styleId: string;
|
|
2593
|
+
/**
|
|
2594
|
+
* Email address shown to end-users in the SSO Suite UI as a support contact.
|
|
2595
|
+
*/
|
|
2596
|
+
supportEmail: string;
|
|
2070
2597
|
}
|
|
2071
2598
|
export interface ProjectAuthenticationTotp {
|
|
2072
2599
|
/**
|
|
@@ -2079,6 +2606,10 @@ export interface ProjectAuthenticationTotp {
|
|
|
2079
2606
|
serviceLabel: string;
|
|
2080
2607
|
}
|
|
2081
2608
|
export interface ProjectAuthorization {
|
|
2609
|
+
/**
|
|
2610
|
+
* 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.
|
|
2611
|
+
*/
|
|
2612
|
+
fga: string;
|
|
2082
2613
|
/**
|
|
2083
2614
|
* A list of `Permission` objects.
|
|
2084
2615
|
*/
|
|
@@ -2128,10 +2659,18 @@ export interface ProjectConnectors {
|
|
|
2128
2659
|
* Utilize IP threat intelligence to block malicious login attempts with the AbuseIPDB connector.
|
|
2129
2660
|
*/
|
|
2130
2661
|
abuseipdbs: outputs.ProjectConnectorsAbuseipdb[];
|
|
2662
|
+
/**
|
|
2663
|
+
* Streamline identity verification and fraud monitoring with the Alloy connector.
|
|
2664
|
+
*/
|
|
2665
|
+
alloys: outputs.ProjectConnectorsAlloy[];
|
|
2131
2666
|
/**
|
|
2132
2667
|
* Track user activity and traits at any point in your user journey with the Amplitude connector.
|
|
2133
2668
|
*/
|
|
2134
2669
|
amplitudes: outputs.ProjectConnectorsAmplitude[];
|
|
2670
|
+
/**
|
|
2671
|
+
* Use the Arkose connector to integrate with Arkose's bot and fraud detection.
|
|
2672
|
+
*/
|
|
2673
|
+
arkoses: outputs.ProjectConnectorsArkose[];
|
|
2135
2674
|
/**
|
|
2136
2675
|
* Send audit events to a custom webhook.
|
|
2137
2676
|
*/
|
|
@@ -2140,6 +2679,10 @@ export interface ProjectConnectors {
|
|
|
2140
2679
|
* Stream authentication audit logs with the Amazon S3 connector.
|
|
2141
2680
|
*/
|
|
2142
2681
|
awsS3s: outputs.ProjectConnectorsAwsS3[];
|
|
2682
|
+
/**
|
|
2683
|
+
* Validate email addresses using the AWS SES Email Validation API to check syntax, DNS records, mailbox existence, and deliverability.
|
|
2684
|
+
*/
|
|
2685
|
+
awsSesEmailValidations: outputs.ProjectConnectorsAwsSesEmailValidation[];
|
|
2143
2686
|
/**
|
|
2144
2687
|
* Localize the language of your login and user journey screens with the Amazon Translate connector.
|
|
2145
2688
|
*/
|
|
@@ -2148,6 +2691,18 @@ export interface ProjectConnectors {
|
|
|
2148
2691
|
* Utilize threat intelligence to block malicious login attempts or check leaks with the Bitsight Threat Intelligence connector.
|
|
2149
2692
|
*/
|
|
2150
2693
|
bitsights: outputs.ProjectConnectorsBitsight[];
|
|
2694
|
+
/**
|
|
2695
|
+
* Send audit events and troubleshooting logs to Coralogix.
|
|
2696
|
+
*/
|
|
2697
|
+
coralogixes: outputs.ProjectConnectorsCoralogix[];
|
|
2698
|
+
/**
|
|
2699
|
+
* 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/
|
|
2700
|
+
*/
|
|
2701
|
+
cribls: outputs.ProjectConnectorsCribl[];
|
|
2702
|
+
/**
|
|
2703
|
+
* Connect to Darwinium API for fraud detection and device intelligence.
|
|
2704
|
+
*/
|
|
2705
|
+
darwinia: outputs.ProjectConnectorsDarwinium[];
|
|
2151
2706
|
/**
|
|
2152
2707
|
* Stream authentication audit logs with the Datadog connector.
|
|
2153
2708
|
*/
|
|
@@ -2212,6 +2767,14 @@ export interface ProjectConnectors {
|
|
|
2212
2767
|
* Get address autocompletions from Place Autocomplete Data API.
|
|
2213
2768
|
*/
|
|
2214
2769
|
googleMapsPlaces: outputs.ProjectConnectorsGoogleMapsPlace[];
|
|
2770
|
+
/**
|
|
2771
|
+
* Send audit events and troubleshooting logs to groundcover.
|
|
2772
|
+
*/
|
|
2773
|
+
groundcovers: outputs.ProjectConnectorsGroundcover[];
|
|
2774
|
+
/**
|
|
2775
|
+
* hCaptcha can help protect your applications from bots, spam, and other forms of automated abuse.
|
|
2776
|
+
*/
|
|
2777
|
+
hcaptchas: outputs.ProjectConnectorsHcaptcha[];
|
|
2215
2778
|
/**
|
|
2216
2779
|
* Check if passwords have been previously exposed in data breaches with the Have I Been Pwned connector.
|
|
2217
2780
|
*/
|
|
@@ -2232,10 +2795,18 @@ export interface ProjectConnectors {
|
|
|
2232
2795
|
* Orchestrate customer identity information from your Descope user journey with the Intercom connector.
|
|
2233
2796
|
*/
|
|
2234
2797
|
intercoms: outputs.ProjectConnectorsIntercom[];
|
|
2798
|
+
/**
|
|
2799
|
+
* Use this connector to authenticate users against an LDAP directory server with support for both password and mTLS authentication.
|
|
2800
|
+
*/
|
|
2801
|
+
ldaps: outputs.ProjectConnectorsLdap[];
|
|
2235
2802
|
/**
|
|
2236
2803
|
* Localize the language of your login and user journey screens with the Lokalise connector.
|
|
2237
2804
|
*/
|
|
2238
2805
|
lokalises: outputs.ProjectConnectorsLokalise[];
|
|
2806
|
+
/**
|
|
2807
|
+
* Stream authentication audit logs and troubleshoot logs to Mixpanel.
|
|
2808
|
+
*/
|
|
2809
|
+
mixpanels: outputs.ProjectConnectorsMixpanel[];
|
|
2239
2810
|
/**
|
|
2240
2811
|
* Track and send user event data (e.g. page views, purchases, etc.) across connected tools using the mParticle connector.
|
|
2241
2812
|
*/
|
|
@@ -2244,6 +2815,22 @@ export interface ProjectConnectors {
|
|
|
2244
2815
|
* Stream authentication audit logs with the New Relic connector.
|
|
2245
2816
|
*/
|
|
2246
2817
|
newrelics: outputs.ProjectConnectorsNewrelic[];
|
|
2818
|
+
/**
|
|
2819
|
+
* Send audit events and troubleshooting logs to an OpenTelemetry-compatible endpoint using OTLP over HTTP or gRPC.
|
|
2820
|
+
*/
|
|
2821
|
+
opentelemetries: outputs.ProjectConnectorsOpentelemetry[];
|
|
2822
|
+
/**
|
|
2823
|
+
* Stream authentication audit logs with the Pendo connector.
|
|
2824
|
+
*/
|
|
2825
|
+
pendos: outputs.ProjectConnectorsPendo[];
|
|
2826
|
+
/**
|
|
2827
|
+
* Authenticate against PingDirectory.
|
|
2828
|
+
*/
|
|
2829
|
+
pingDirectories: outputs.ProjectConnectorsPingDirectory[];
|
|
2830
|
+
/**
|
|
2831
|
+
* Send emails using Postmark
|
|
2832
|
+
*/
|
|
2833
|
+
postmarks: outputs.ProjectConnectorsPostmark[];
|
|
2247
2834
|
/**
|
|
2248
2835
|
* Get address autocompletions from Radar Autocomplete API.
|
|
2249
2836
|
*/
|
|
@@ -2252,6 +2839,10 @@ export interface ProjectConnectors {
|
|
|
2252
2839
|
* Mitigate fraud using advanced risk analysis and add adaptive MFA with the reCAPTCHA Enterprise connector.
|
|
2253
2840
|
*/
|
|
2254
2841
|
recaptchaEnterprises: outputs.ProjectConnectorsRecaptchaEnterprise[];
|
|
2842
|
+
/**
|
|
2843
|
+
* Use the reCAPTCHA v2 "I'm not a robot" checkbox widget with your flows.
|
|
2844
|
+
*/
|
|
2845
|
+
recaptchaV2s: outputs.ProjectConnectorsRecaptchaV2[];
|
|
2255
2846
|
/**
|
|
2256
2847
|
* Prevent bot attacks on your login pages with the reCAPTCHA v3 connector.
|
|
2257
2848
|
*/
|
|
@@ -2260,6 +2851,10 @@ export interface ProjectConnectors {
|
|
|
2260
2851
|
* Add image recognition capabilities for identity verification and fraud prevention with the Amazon Rekognition connector.
|
|
2261
2852
|
*/
|
|
2262
2853
|
rekognitions: outputs.ProjectConnectorsRekognition[];
|
|
2854
|
+
/**
|
|
2855
|
+
* 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.
|
|
2856
|
+
*/
|
|
2857
|
+
rndReassigneds: outputs.ProjectConnectorsRndReassigned[];
|
|
2263
2858
|
/**
|
|
2264
2859
|
* Send transactional messages with the Salesforce Marketing Cloud connector.
|
|
2265
2860
|
*/
|
|
@@ -2272,6 +2867,10 @@ export interface ProjectConnectors {
|
|
|
2272
2867
|
* Evaluate customer risk using Sardine
|
|
2273
2868
|
*/
|
|
2274
2869
|
sardines: outputs.ProjectConnectorsSardine[];
|
|
2870
|
+
/**
|
|
2871
|
+
* Provision and de-provision users to an external SCIM v2 endpoint as part of your Descope user journey.
|
|
2872
|
+
*/
|
|
2873
|
+
scims: outputs.ProjectConnectorsScim[];
|
|
2275
2874
|
/**
|
|
2276
2875
|
* Orchestrate customer identity traits and signals from your Descope user journey with the Segment connector.
|
|
2277
2876
|
*/
|
|
@@ -2296,10 +2895,22 @@ export interface ProjectConnectors {
|
|
|
2296
2895
|
* Simple Mail Transfer Protocol (SMTP) server for sending emails.
|
|
2297
2896
|
*/
|
|
2298
2897
|
smtps: outputs.ProjectConnectorsSmtp[];
|
|
2898
|
+
/**
|
|
2899
|
+
* Stream authentication audit logs to your Snowflake data warehouse with the Snowflake connector.
|
|
2900
|
+
*/
|
|
2901
|
+
snowflakes: outputs.ProjectConnectorsSnowflake[];
|
|
2299
2902
|
/**
|
|
2300
2903
|
* Amazon Simple Notification Service (SNS) for sending SMS messages through AWS.
|
|
2301
2904
|
*/
|
|
2302
2905
|
sns: outputs.ProjectConnectorsSn[];
|
|
2906
|
+
/**
|
|
2907
|
+
* Stream logs and audit events with the Splunk HTTP Event Collector (HEC).
|
|
2908
|
+
*/
|
|
2909
|
+
splunks: outputs.ProjectConnectorsSplunk[];
|
|
2910
|
+
/**
|
|
2911
|
+
* SQL connector for relational databases including PostgreSQL, MySQL, MariaDB, Microsoft SQL Server (MSSQL), Oracle, CockroachDB, and Amazon Redshift.
|
|
2912
|
+
*/
|
|
2913
|
+
sqls: outputs.ProjectConnectorsSql[];
|
|
2303
2914
|
/**
|
|
2304
2915
|
* Stream logs and audit events with the Sumo Logic connector.
|
|
2305
2916
|
*/
|
|
@@ -2328,6 +2939,14 @@ export interface ProjectConnectors {
|
|
|
2328
2939
|
* 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
2940
|
*/
|
|
2330
2941
|
twilioVerifies: outputs.ProjectConnectorsTwilioVerify[];
|
|
2942
|
+
/**
|
|
2943
|
+
* SIM-based authentication and approval using Unibeam's OnSim technology for passwordless authentication and transaction approval.
|
|
2944
|
+
*/
|
|
2945
|
+
unibeams: outputs.ProjectConnectorsUnibeam[];
|
|
2946
|
+
/**
|
|
2947
|
+
* Email validation with ZeroBounce
|
|
2948
|
+
*/
|
|
2949
|
+
zerobounces: outputs.ProjectConnectorsZerobounce[];
|
|
2331
2950
|
}
|
|
2332
2951
|
export interface ProjectConnectorsAbuseipdb {
|
|
2333
2952
|
/**
|
|
@@ -2344,6 +2963,29 @@ export interface ProjectConnectorsAbuseipdb {
|
|
|
2344
2963
|
*/
|
|
2345
2964
|
name: string;
|
|
2346
2965
|
}
|
|
2966
|
+
export interface ProjectConnectorsAlloy {
|
|
2967
|
+
/**
|
|
2968
|
+
* The Alloy API secret.
|
|
2969
|
+
*/
|
|
2970
|
+
apiSecret: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* The Alloy API token.
|
|
2973
|
+
*/
|
|
2974
|
+
apiToken: string;
|
|
2975
|
+
/**
|
|
2976
|
+
* The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
|
|
2977
|
+
*/
|
|
2978
|
+
baseUrl: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* A description of what your connector is used for.
|
|
2981
|
+
*/
|
|
2982
|
+
description: string;
|
|
2983
|
+
id: string;
|
|
2984
|
+
/**
|
|
2985
|
+
* A custom name for your connector.
|
|
2986
|
+
*/
|
|
2987
|
+
name: string;
|
|
2988
|
+
}
|
|
2347
2989
|
export interface ProjectConnectorsAmplitude {
|
|
2348
2990
|
/**
|
|
2349
2991
|
* The Amplitude API Key generated for the Descope service.
|
|
@@ -2367,6 +3009,33 @@ export interface ProjectConnectorsAmplitude {
|
|
|
2367
3009
|
*/
|
|
2368
3010
|
serverZone: string;
|
|
2369
3011
|
}
|
|
3012
|
+
export interface ProjectConnectorsArkose {
|
|
3013
|
+
/**
|
|
3014
|
+
* 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.
|
|
3015
|
+
*/
|
|
3016
|
+
clientBaseUrl: string;
|
|
3017
|
+
/**
|
|
3018
|
+
* A description of what your connector is used for.
|
|
3019
|
+
*/
|
|
3020
|
+
description: string;
|
|
3021
|
+
id: string;
|
|
3022
|
+
/**
|
|
3023
|
+
* A custom name for your connector.
|
|
3024
|
+
*/
|
|
3025
|
+
name: string;
|
|
3026
|
+
/**
|
|
3027
|
+
* The private key that can be copied from the Keys screen in the Arkose Labs portal.
|
|
3028
|
+
*/
|
|
3029
|
+
privateKey: string;
|
|
3030
|
+
/**
|
|
3031
|
+
* The public key that's shown in the Keys screen in the Arkose Labs portal.
|
|
3032
|
+
*/
|
|
3033
|
+
publicKey: string;
|
|
3034
|
+
/**
|
|
3035
|
+
* 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.
|
|
3036
|
+
*/
|
|
3037
|
+
verifyBaseUrl: string;
|
|
3038
|
+
}
|
|
2370
3039
|
export interface ProjectConnectorsAuditWebhook {
|
|
2371
3040
|
/**
|
|
2372
3041
|
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
@@ -2482,6 +3151,10 @@ export interface ProjectConnectorsAwsS3 {
|
|
|
2482
3151
|
*/
|
|
2483
3152
|
externalId: string;
|
|
2484
3153
|
id: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* Whether to mask personally identifiable information in the logs.
|
|
3156
|
+
*/
|
|
3157
|
+
maskPii: boolean;
|
|
2485
3158
|
/**
|
|
2486
3159
|
* A custom name for your connector.
|
|
2487
3160
|
*/
|
|
@@ -2517,6 +3190,45 @@ export interface ProjectConnectorsAwsS3AuditFilter {
|
|
|
2517
3190
|
*/
|
|
2518
3191
|
values: string[];
|
|
2519
3192
|
}
|
|
3193
|
+
export interface ProjectConnectorsAwsSesEmailValidation {
|
|
3194
|
+
/**
|
|
3195
|
+
* AWS access key ID.
|
|
3196
|
+
*/
|
|
3197
|
+
accessKeyId: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* The authentication type to use.
|
|
3200
|
+
*/
|
|
3201
|
+
authType: string;
|
|
3202
|
+
/**
|
|
3203
|
+
* A description of what your connector is used for.
|
|
3204
|
+
*/
|
|
3205
|
+
description: string;
|
|
3206
|
+
/**
|
|
3207
|
+
* The external ID to use when assuming the role.
|
|
3208
|
+
*/
|
|
3209
|
+
externalId: string;
|
|
3210
|
+
id: string;
|
|
3211
|
+
/**
|
|
3212
|
+
* A custom name for your connector.
|
|
3213
|
+
*/
|
|
3214
|
+
name: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* The AWS region to which this client will send requests. (e.g. us-east-1.)
|
|
3217
|
+
*/
|
|
3218
|
+
region: string;
|
|
3219
|
+
/**
|
|
3220
|
+
* The Amazon Resource Name (ARN) of the role to assume.
|
|
3221
|
+
*/
|
|
3222
|
+
roleArn: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* AWS secret access key.
|
|
3225
|
+
*/
|
|
3226
|
+
secretAccessKey: string;
|
|
3227
|
+
/**
|
|
3228
|
+
* (Optional) A security or session token to use with these credentials. Usually present for temporary credentials.
|
|
3229
|
+
*/
|
|
3230
|
+
sessionToken: string;
|
|
3231
|
+
}
|
|
2520
3232
|
export interface ProjectConnectorsAwsTranslate {
|
|
2521
3233
|
/**
|
|
2522
3234
|
* AWS access key ID.
|
|
@@ -2563,11 +3275,7 @@ export interface ProjectConnectorsBitsight {
|
|
|
2563
3275
|
*/
|
|
2564
3276
|
name: string;
|
|
2565
3277
|
}
|
|
2566
|
-
export interface
|
|
2567
|
-
/**
|
|
2568
|
-
* The unique Datadog organization key.
|
|
2569
|
-
*/
|
|
2570
|
-
apiKey: string;
|
|
3278
|
+
export interface ProjectConnectorsCoralogix {
|
|
2571
3279
|
/**
|
|
2572
3280
|
* Whether to enable streaming of audit events.
|
|
2573
3281
|
*/
|
|
@@ -2575,11 +3283,19 @@ export interface ProjectConnectorsDatadog {
|
|
|
2575
3283
|
/**
|
|
2576
3284
|
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
2577
3285
|
*/
|
|
2578
|
-
auditFilters: outputs.
|
|
3286
|
+
auditFilters: outputs.ProjectConnectorsCoralogixAuditFilter[];
|
|
3287
|
+
/**
|
|
3288
|
+
* Bearer token issued by Coralogix as Send-Your-Data API key
|
|
3289
|
+
*/
|
|
3290
|
+
bearerToken: string;
|
|
2579
3291
|
/**
|
|
2580
3292
|
* A description of what your connector is used for.
|
|
2581
3293
|
*/
|
|
2582
3294
|
description: string;
|
|
3295
|
+
/**
|
|
3296
|
+
* The ingress OpenTelemetry endpoint URL.
|
|
3297
|
+
*/
|
|
3298
|
+
endpoint: string;
|
|
2583
3299
|
id: string;
|
|
2584
3300
|
/**
|
|
2585
3301
|
* Whether to mask personally identifiable information in the logs.
|
|
@@ -2589,16 +3305,12 @@ export interface ProjectConnectorsDatadog {
|
|
|
2589
3305
|
* A custom name for your connector.
|
|
2590
3306
|
*/
|
|
2591
3307
|
name: string;
|
|
2592
|
-
/**
|
|
2593
|
-
* The Datadog site to send logs to. Default is `datadoghq.com`. European, free tier and other customers should set their site accordingly.
|
|
2594
|
-
*/
|
|
2595
|
-
site: string;
|
|
2596
3308
|
/**
|
|
2597
3309
|
* Whether to send troubleshooting events.
|
|
2598
3310
|
*/
|
|
2599
3311
|
troubleshootLogEnabled: boolean;
|
|
2600
3312
|
}
|
|
2601
|
-
export interface
|
|
3313
|
+
export interface ProjectConnectorsCoralogixAuditFilter {
|
|
2602
3314
|
/**
|
|
2603
3315
|
* The field name to filter on (either 'actions' or 'tenants').
|
|
2604
3316
|
*/
|
|
@@ -2612,53 +3324,214 @@ export interface ProjectConnectorsDatadogAuditFilter {
|
|
|
2612
3324
|
*/
|
|
2613
3325
|
values: string[];
|
|
2614
3326
|
}
|
|
2615
|
-
export interface
|
|
2616
|
-
/**
|
|
2617
|
-
* Authentication to DevRev APIs requires a personal access token (PAT).
|
|
2618
|
-
*/
|
|
2619
|
-
apiKey: string;
|
|
3327
|
+
export interface ProjectConnectorsCribl {
|
|
2620
3328
|
/**
|
|
2621
|
-
*
|
|
3329
|
+
* Whether to enable streaming of audit events.
|
|
2622
3330
|
*/
|
|
2623
|
-
|
|
2624
|
-
id: string;
|
|
3331
|
+
auditEnabled: boolean;
|
|
2625
3332
|
/**
|
|
2626
|
-
*
|
|
3333
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
2627
3334
|
*/
|
|
2628
|
-
|
|
2629
|
-
}
|
|
2630
|
-
export interface ProjectConnectorsDocebo {
|
|
3335
|
+
auditFilters: outputs.ProjectConnectorsCriblAuditFilter[];
|
|
2631
3336
|
/**
|
|
2632
|
-
*
|
|
3337
|
+
* 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.
|
|
2633
3338
|
*/
|
|
2634
|
-
|
|
3339
|
+
authToken: string;
|
|
2635
3340
|
/**
|
|
2636
|
-
*
|
|
3341
|
+
* A description of what your connector is used for.
|
|
2637
3342
|
*/
|
|
2638
|
-
|
|
3343
|
+
description: string;
|
|
2639
3344
|
/**
|
|
2640
|
-
* The
|
|
3345
|
+
* 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.
|
|
2641
3346
|
*/
|
|
2642
|
-
|
|
3347
|
+
endpoint: string;
|
|
3348
|
+
id: string;
|
|
2643
3349
|
/**
|
|
2644
|
-
*
|
|
3350
|
+
* Whether to mask personally identifiable information in the logs.
|
|
2645
3351
|
*/
|
|
2646
|
-
|
|
2647
|
-
id: string;
|
|
3352
|
+
maskPii: boolean;
|
|
2648
3353
|
/**
|
|
2649
3354
|
* A custom name for your connector.
|
|
2650
3355
|
*/
|
|
2651
3356
|
name: string;
|
|
2652
3357
|
/**
|
|
2653
|
-
*
|
|
3358
|
+
* An optional source identifier for events in Cribl (defaults to 'descope').
|
|
2654
3359
|
*/
|
|
2655
|
-
|
|
3360
|
+
source: string;
|
|
2656
3361
|
/**
|
|
2657
|
-
*
|
|
3362
|
+
* Whether to send troubleshooting events.
|
|
2658
3363
|
*/
|
|
2659
|
-
|
|
3364
|
+
troubleshootLogEnabled: boolean;
|
|
2660
3365
|
}
|
|
2661
|
-
export interface
|
|
3366
|
+
export interface ProjectConnectorsCriblAuditFilter {
|
|
3367
|
+
/**
|
|
3368
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
3369
|
+
*/
|
|
3370
|
+
key: string;
|
|
3371
|
+
/**
|
|
3372
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
3373
|
+
*/
|
|
3374
|
+
operator: string;
|
|
3375
|
+
/**
|
|
3376
|
+
* The list of values to match against for the filter.
|
|
3377
|
+
*/
|
|
3378
|
+
values: string[];
|
|
3379
|
+
}
|
|
3380
|
+
export interface ProjectConnectorsDarwinium {
|
|
3381
|
+
/**
|
|
3382
|
+
* The default result to return if no result is available.
|
|
3383
|
+
*/
|
|
3384
|
+
defaultResult: string;
|
|
3385
|
+
/**
|
|
3386
|
+
* A description of what your connector is used for.
|
|
3387
|
+
*/
|
|
3388
|
+
description: string;
|
|
3389
|
+
id: string;
|
|
3390
|
+
/**
|
|
3391
|
+
* The name of the Darwinium journey to use for profiling.
|
|
3392
|
+
*/
|
|
3393
|
+
journeyName: string;
|
|
3394
|
+
/**
|
|
3395
|
+
* A custom name for your connector.
|
|
3396
|
+
*/
|
|
3397
|
+
name: string;
|
|
3398
|
+
/**
|
|
3399
|
+
* The name of the Darwinium Native Mobile API to use.
|
|
3400
|
+
*/
|
|
3401
|
+
nativeApiName: string;
|
|
3402
|
+
/**
|
|
3403
|
+
* The key name for the native profiling blob sent via the client parameter. If not provided, the default key of 'nativeProfilingBlob' will be used.
|
|
3404
|
+
*/
|
|
3405
|
+
nativeBlobKeyName: string;
|
|
3406
|
+
/**
|
|
3407
|
+
* The name of the Darwinium node.
|
|
3408
|
+
*/
|
|
3409
|
+
nodeName: string;
|
|
3410
|
+
/**
|
|
3411
|
+
* The passphrase for the PEM certificate, if applicable.
|
|
3412
|
+
*/
|
|
3413
|
+
passphrase: string;
|
|
3414
|
+
/**
|
|
3415
|
+
* The PEM certificate for client authentication.
|
|
3416
|
+
*/
|
|
3417
|
+
pemCertificate: string;
|
|
3418
|
+
/**
|
|
3419
|
+
* The private key for client authentication.
|
|
3420
|
+
*/
|
|
3421
|
+
privateKey: string;
|
|
3422
|
+
/**
|
|
3423
|
+
* The custom URL where the Darwinium Tags script is hosted. If not provided, the default Darwinium script URL will be used.
|
|
3424
|
+
*/
|
|
3425
|
+
profilingTagsScriptUrl: string;
|
|
3426
|
+
/**
|
|
3427
|
+
* The name of the Darwinium Web API to use.
|
|
3428
|
+
*/
|
|
3429
|
+
webApiName: string;
|
|
3430
|
+
}
|
|
3431
|
+
export interface ProjectConnectorsDatadog {
|
|
3432
|
+
/**
|
|
3433
|
+
* The unique Datadog organization key.
|
|
3434
|
+
*/
|
|
3435
|
+
apiKey: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* Whether to enable streaming of audit events.
|
|
3438
|
+
*/
|
|
3439
|
+
auditEnabled: boolean;
|
|
3440
|
+
/**
|
|
3441
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
3442
|
+
*/
|
|
3443
|
+
auditFilters: outputs.ProjectConnectorsDatadogAuditFilter[];
|
|
3444
|
+
/**
|
|
3445
|
+
* A description of what your connector is used for.
|
|
3446
|
+
*/
|
|
3447
|
+
description: string;
|
|
3448
|
+
id: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Whether to mask personally identifiable information in the logs.
|
|
3451
|
+
*/
|
|
3452
|
+
maskPii: boolean;
|
|
3453
|
+
/**
|
|
3454
|
+
* A custom name for your connector.
|
|
3455
|
+
*/
|
|
3456
|
+
name: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* The Datadog site to send logs to. Default is `datadoghq.com`. European, free tier and other customers should set their site accordingly.
|
|
3459
|
+
*/
|
|
3460
|
+
site: string;
|
|
3461
|
+
/**
|
|
3462
|
+
* 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.
|
|
3463
|
+
*/
|
|
3464
|
+
source: string;
|
|
3465
|
+
/**
|
|
3466
|
+
* 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.
|
|
3467
|
+
*/
|
|
3468
|
+
tags: string;
|
|
3469
|
+
/**
|
|
3470
|
+
* Whether to send troubleshooting events.
|
|
3471
|
+
*/
|
|
3472
|
+
troubleshootLogEnabled: boolean;
|
|
3473
|
+
}
|
|
3474
|
+
export interface ProjectConnectorsDatadogAuditFilter {
|
|
3475
|
+
/**
|
|
3476
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
3477
|
+
*/
|
|
3478
|
+
key: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
3481
|
+
*/
|
|
3482
|
+
operator: string;
|
|
3483
|
+
/**
|
|
3484
|
+
* The list of values to match against for the filter.
|
|
3485
|
+
*/
|
|
3486
|
+
values: string[];
|
|
3487
|
+
}
|
|
3488
|
+
export interface ProjectConnectorsDevrevGrow {
|
|
3489
|
+
/**
|
|
3490
|
+
* Authentication to DevRev APIs requires a personal access token (PAT).
|
|
3491
|
+
*/
|
|
3492
|
+
apiKey: string;
|
|
3493
|
+
/**
|
|
3494
|
+
* A description of what your connector is used for.
|
|
3495
|
+
*/
|
|
3496
|
+
description: string;
|
|
3497
|
+
id: string;
|
|
3498
|
+
/**
|
|
3499
|
+
* A custom name for your connector.
|
|
3500
|
+
*/
|
|
3501
|
+
name: string;
|
|
3502
|
+
}
|
|
3503
|
+
export interface ProjectConnectorsDocebo {
|
|
3504
|
+
/**
|
|
3505
|
+
* The Docebo api base url.
|
|
3506
|
+
*/
|
|
3507
|
+
baseUrl: string;
|
|
3508
|
+
/**
|
|
3509
|
+
* The Docebo OAuth 2.0 app client ID.
|
|
3510
|
+
*/
|
|
3511
|
+
clientId: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* The Docebo OAuth 2.0 app client secret.
|
|
3514
|
+
*/
|
|
3515
|
+
clientSecret: string;
|
|
3516
|
+
/**
|
|
3517
|
+
* A description of what your connector is used for.
|
|
3518
|
+
*/
|
|
3519
|
+
description: string;
|
|
3520
|
+
id: string;
|
|
3521
|
+
/**
|
|
3522
|
+
* A custom name for your connector.
|
|
3523
|
+
*/
|
|
3524
|
+
name: string;
|
|
3525
|
+
/**
|
|
3526
|
+
* The Docebo user's password.
|
|
3527
|
+
*/
|
|
3528
|
+
password: string;
|
|
3529
|
+
/**
|
|
3530
|
+
* The Docebo username.
|
|
3531
|
+
*/
|
|
3532
|
+
username: string;
|
|
3533
|
+
}
|
|
3534
|
+
export interface ProjectConnectorsEightByEightViber {
|
|
2662
3535
|
/**
|
|
2663
3536
|
* The 8x8 API key for authentication.
|
|
2664
3537
|
*/
|
|
@@ -3135,6 +4008,86 @@ export interface ProjectConnectorsGoogleMapsPlace {
|
|
|
3135
4008
|
*/
|
|
3136
4009
|
region: string;
|
|
3137
4010
|
}
|
|
4011
|
+
export interface ProjectConnectorsGroundcover {
|
|
4012
|
+
/**
|
|
4013
|
+
* Whether to enable streaming of audit events.
|
|
4014
|
+
*/
|
|
4015
|
+
auditEnabled: boolean;
|
|
4016
|
+
/**
|
|
4017
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
4018
|
+
*/
|
|
4019
|
+
auditFilters: outputs.ProjectConnectorsGroundcoverAuditFilter[];
|
|
4020
|
+
/**
|
|
4021
|
+
* A description of what your connector is used for.
|
|
4022
|
+
*/
|
|
4023
|
+
description: string;
|
|
4024
|
+
/**
|
|
4025
|
+
* The gRPC OTLP backend endpoint URL. Found in the groundcover console under Settings → Ingestion Keys → Backend Endpoints.
|
|
4026
|
+
*/
|
|
4027
|
+
endpoint: string;
|
|
4028
|
+
id: string;
|
|
4029
|
+
/**
|
|
4030
|
+
* Third Party ingestion key for authenticating with groundcover. Create one in the groundcover console under Settings → Ingestion Keys (type: thirdParty).
|
|
4031
|
+
*/
|
|
4032
|
+
ingestionKey: string;
|
|
4033
|
+
/**
|
|
4034
|
+
* Whether to mask personally identifiable information in the logs.
|
|
4035
|
+
*/
|
|
4036
|
+
maskPii: boolean;
|
|
4037
|
+
/**
|
|
4038
|
+
* A custom name for your connector.
|
|
4039
|
+
*/
|
|
4040
|
+
name: string;
|
|
4041
|
+
/**
|
|
4042
|
+
* Whether to send troubleshooting events.
|
|
4043
|
+
*/
|
|
4044
|
+
troubleshootLogEnabled: boolean;
|
|
4045
|
+
}
|
|
4046
|
+
export interface ProjectConnectorsGroundcoverAuditFilter {
|
|
4047
|
+
/**
|
|
4048
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
4049
|
+
*/
|
|
4050
|
+
key: string;
|
|
4051
|
+
/**
|
|
4052
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
4053
|
+
*/
|
|
4054
|
+
operator: string;
|
|
4055
|
+
/**
|
|
4056
|
+
* The list of values to match against for the filter.
|
|
4057
|
+
*/
|
|
4058
|
+
values: string[];
|
|
4059
|
+
}
|
|
4060
|
+
export interface ProjectConnectorsHcaptcha {
|
|
4061
|
+
/**
|
|
4062
|
+
* 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.
|
|
4063
|
+
*/
|
|
4064
|
+
assessmentScore: number;
|
|
4065
|
+
/**
|
|
4066
|
+
* 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.
|
|
4067
|
+
*/
|
|
4068
|
+
botThreshold: number;
|
|
4069
|
+
/**
|
|
4070
|
+
* A description of what your connector is used for.
|
|
4071
|
+
*/
|
|
4072
|
+
description: string;
|
|
4073
|
+
id: string;
|
|
4074
|
+
/**
|
|
4075
|
+
* A custom name for your connector.
|
|
4076
|
+
*/
|
|
4077
|
+
name: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* Override the default assessment model. Note: Overriding assessment is intended for automated testing and should not be utilized in production environments.
|
|
4080
|
+
*/
|
|
4081
|
+
overrideAssessment: boolean;
|
|
4082
|
+
/**
|
|
4083
|
+
* The secret key authorizes communication between Descope backend and the hCaptcha server to verify the user's response.
|
|
4084
|
+
*/
|
|
4085
|
+
secretKey: string;
|
|
4086
|
+
/**
|
|
4087
|
+
* The site key is used to invoke hCaptcha service on your site or mobile application.
|
|
4088
|
+
*/
|
|
4089
|
+
siteKey: string;
|
|
4090
|
+
}
|
|
3138
4091
|
export interface ProjectConnectorsHibp {
|
|
3139
4092
|
/**
|
|
3140
4093
|
* A description of what your connector is used for.
|
|
@@ -3151,6 +4104,34 @@ export interface ProjectConnectorsHttp {
|
|
|
3151
4104
|
* Authentication Information
|
|
3152
4105
|
*/
|
|
3153
4106
|
authentication: outputs.ProjectConnectorsHttpAuthentication;
|
|
4107
|
+
/**
|
|
4108
|
+
* The unique AWS access key ID.
|
|
4109
|
+
*/
|
|
4110
|
+
awsAccessKeyId: string;
|
|
4111
|
+
/**
|
|
4112
|
+
* Apply AWS signature version 4 authentication to the request.
|
|
4113
|
+
*/
|
|
4114
|
+
awsAuthType: string;
|
|
4115
|
+
/**
|
|
4116
|
+
* The external ID to use when assuming the role.
|
|
4117
|
+
*/
|
|
4118
|
+
awsExternalId: string;
|
|
4119
|
+
/**
|
|
4120
|
+
* The AWS region, e.g. `us-east-1`.
|
|
4121
|
+
*/
|
|
4122
|
+
awsRegion: string;
|
|
4123
|
+
/**
|
|
4124
|
+
* The Amazon Resource Name (ARN) of the role to assume.
|
|
4125
|
+
*/
|
|
4126
|
+
awsRoleArn: string;
|
|
4127
|
+
/**
|
|
4128
|
+
* The secret AWS access key.
|
|
4129
|
+
*/
|
|
4130
|
+
awsSecretAccessKey: string;
|
|
4131
|
+
/**
|
|
4132
|
+
* The AWS service to target, e.g. `lambda`, `execute-api`, `s3`, etc.
|
|
4133
|
+
*/
|
|
4134
|
+
awsService: string;
|
|
3154
4135
|
/**
|
|
3155
4136
|
* The base URL to fetch
|
|
3156
4137
|
*/
|
|
@@ -3171,7 +4152,7 @@ export interface ProjectConnectorsHttp {
|
|
|
3171
4152
|
hmacSecret: string;
|
|
3172
4153
|
id: string;
|
|
3173
4154
|
/**
|
|
3174
|
-
* The connector response context will also include the headers. The context will have a "body" attribute and a "
|
|
4155
|
+
* 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
4156
|
*/
|
|
3176
4157
|
includeHeadersInContext: boolean;
|
|
3177
4158
|
/**
|
|
@@ -3182,6 +4163,26 @@ export interface ProjectConnectorsHttp {
|
|
|
3182
4163
|
* A custom name for your connector.
|
|
3183
4164
|
*/
|
|
3184
4165
|
name: string;
|
|
4166
|
+
/**
|
|
4167
|
+
* 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
|
|
4168
|
+
*/
|
|
4169
|
+
rfc9421Components: string;
|
|
4170
|
+
/**
|
|
4171
|
+
* Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
|
|
4172
|
+
*/
|
|
4173
|
+
rfc9421KeyId: string;
|
|
4174
|
+
/**
|
|
4175
|
+
* 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.
|
|
4176
|
+
*/
|
|
4177
|
+
rfc9421PrivateKey: string;
|
|
4178
|
+
/**
|
|
4179
|
+
* 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
|
|
4180
|
+
*/
|
|
4181
|
+
rfc9421SignatureTtl: number;
|
|
4182
|
+
/**
|
|
4183
|
+
* Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
|
|
4184
|
+
*/
|
|
4185
|
+
rfc9421SigningEnabled: boolean;
|
|
3185
4186
|
/**
|
|
3186
4187
|
* Whether the connector should send all requests from specific static IPs.
|
|
3187
4188
|
*/
|
|
@@ -3286,15 +4287,27 @@ export interface ProjectConnectorsIntercom {
|
|
|
3286
4287
|
*/
|
|
3287
4288
|
token: string;
|
|
3288
4289
|
}
|
|
3289
|
-
export interface
|
|
4290
|
+
export interface ProjectConnectorsLdap {
|
|
3290
4291
|
/**
|
|
3291
|
-
*
|
|
4292
|
+
* The Distinguished Name to bind with for searching.
|
|
3292
4293
|
*/
|
|
3293
|
-
|
|
4294
|
+
bindDn: string;
|
|
3294
4295
|
/**
|
|
3295
|
-
*
|
|
4296
|
+
* The password for the bind DN.
|
|
3296
4297
|
*/
|
|
3297
|
-
|
|
4298
|
+
bindPassword: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* The Certificate Authority certificate in PEM format for validating the server certificate.
|
|
4301
|
+
*/
|
|
4302
|
+
caCertificate: string;
|
|
4303
|
+
/**
|
|
4304
|
+
* The client certificate in PEM format for mTLS authentication.
|
|
4305
|
+
*/
|
|
4306
|
+
clientCertificate: string;
|
|
4307
|
+
/**
|
|
4308
|
+
* The client private key in PEM format for mTLS authentication.
|
|
4309
|
+
*/
|
|
4310
|
+
clientKey: string;
|
|
3298
4311
|
/**
|
|
3299
4312
|
* A description of what your connector is used for.
|
|
3300
4313
|
*/
|
|
@@ -3305,11 +4318,42 @@ export interface ProjectConnectorsLokalise {
|
|
|
3305
4318
|
*/
|
|
3306
4319
|
name: string;
|
|
3307
4320
|
/**
|
|
3308
|
-
*
|
|
4321
|
+
* Reject connections to LDAP servers with invalid certificates.
|
|
3309
4322
|
*/
|
|
3310
|
-
|
|
4323
|
+
rejectUnauthorized: boolean;
|
|
3311
4324
|
/**
|
|
3312
|
-
*
|
|
4325
|
+
* The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
|
|
4326
|
+
*/
|
|
4327
|
+
serverUrl: string;
|
|
4328
|
+
/**
|
|
4329
|
+
* Enable mutual TLS authentication for LDAP connection.
|
|
4330
|
+
*/
|
|
4331
|
+
useMtls: boolean;
|
|
4332
|
+
}
|
|
4333
|
+
export interface ProjectConnectorsLokalise {
|
|
4334
|
+
/**
|
|
4335
|
+
* Lokalise API token.
|
|
4336
|
+
*/
|
|
4337
|
+
apiToken: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* (Optional) The ID of the payment card to use for translation orders. If not provided, the team credit will be used.
|
|
4340
|
+
*/
|
|
4341
|
+
cardId: string;
|
|
4342
|
+
/**
|
|
4343
|
+
* A description of what your connector is used for.
|
|
4344
|
+
*/
|
|
4345
|
+
description: string;
|
|
4346
|
+
id: string;
|
|
4347
|
+
/**
|
|
4348
|
+
* A custom name for your connector.
|
|
4349
|
+
*/
|
|
4350
|
+
name: string;
|
|
4351
|
+
/**
|
|
4352
|
+
* Lokalise project ID.
|
|
4353
|
+
*/
|
|
4354
|
+
projectId: string;
|
|
4355
|
+
/**
|
|
4356
|
+
* Lokalise team ID. If not provided, the oldest available team will be used.
|
|
3313
4357
|
*/
|
|
3314
4358
|
teamId: string;
|
|
3315
4359
|
/**
|
|
@@ -3317,6 +4361,75 @@ export interface ProjectConnectorsLokalise {
|
|
|
3317
4361
|
*/
|
|
3318
4362
|
translationProvider: string;
|
|
3319
4363
|
}
|
|
4364
|
+
export interface ProjectConnectorsMixpanel {
|
|
4365
|
+
/**
|
|
4366
|
+
* The Mixpanel API secret key used for authenticating API requests.
|
|
4367
|
+
*/
|
|
4368
|
+
apiSecret: string;
|
|
4369
|
+
/**
|
|
4370
|
+
* Whether to enable streaming of audit events.
|
|
4371
|
+
*/
|
|
4372
|
+
auditEnabled: boolean;
|
|
4373
|
+
/**
|
|
4374
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
4375
|
+
*/
|
|
4376
|
+
auditFilters: outputs.ProjectConnectorsMixpanelAuditFilter[];
|
|
4377
|
+
/**
|
|
4378
|
+
* A description of what your connector is used for.
|
|
4379
|
+
*/
|
|
4380
|
+
description: string;
|
|
4381
|
+
/**
|
|
4382
|
+
* Indicates if your Mixpanel project data is stored in the EU region.
|
|
4383
|
+
*/
|
|
4384
|
+
euResidency: boolean;
|
|
4385
|
+
id: string;
|
|
4386
|
+
/**
|
|
4387
|
+
* Specify a custom prefix for all log fields. The default prefix is `descope.`.
|
|
4388
|
+
*/
|
|
4389
|
+
logsPrefix: string;
|
|
4390
|
+
/**
|
|
4391
|
+
* A custom name for your connector.
|
|
4392
|
+
*/
|
|
4393
|
+
name: string;
|
|
4394
|
+
/**
|
|
4395
|
+
* Enable this option to use a custom prefix for log fields.
|
|
4396
|
+
*/
|
|
4397
|
+
overrideLogsPrefix: boolean;
|
|
4398
|
+
/**
|
|
4399
|
+
* The unique identifier for your Mixpanel project.
|
|
4400
|
+
*/
|
|
4401
|
+
projectId: string;
|
|
4402
|
+
/**
|
|
4403
|
+
* The unique Mixpanel project token used to identify the project where data will be sent.
|
|
4404
|
+
*/
|
|
4405
|
+
projectToken: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* The Mixpanel service account secret used for integration.
|
|
4408
|
+
*/
|
|
4409
|
+
serviceAccountSecret: string;
|
|
4410
|
+
/**
|
|
4411
|
+
* The Mixpanel service account username used for integration.
|
|
4412
|
+
*/
|
|
4413
|
+
serviceAccountUsername: string;
|
|
4414
|
+
/**
|
|
4415
|
+
* Whether to send troubleshooting events.
|
|
4416
|
+
*/
|
|
4417
|
+
troubleshootLogEnabled: boolean;
|
|
4418
|
+
}
|
|
4419
|
+
export interface ProjectConnectorsMixpanelAuditFilter {
|
|
4420
|
+
/**
|
|
4421
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
4422
|
+
*/
|
|
4423
|
+
key: string;
|
|
4424
|
+
/**
|
|
4425
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
4426
|
+
*/
|
|
4427
|
+
operator: string;
|
|
4428
|
+
/**
|
|
4429
|
+
* The list of values to match against for the filter.
|
|
4430
|
+
*/
|
|
4431
|
+
values: string[];
|
|
4432
|
+
}
|
|
3320
4433
|
export interface ProjectConnectorsMparticle {
|
|
3321
4434
|
/**
|
|
3322
4435
|
* The mParticle Server to Server Key generated for the Descope service.
|
|
@@ -3401,6 +4514,190 @@ export interface ProjectConnectorsNewrelicAuditFilter {
|
|
|
3401
4514
|
*/
|
|
3402
4515
|
values: string[];
|
|
3403
4516
|
}
|
|
4517
|
+
export interface ProjectConnectorsOpentelemetry {
|
|
4518
|
+
/**
|
|
4519
|
+
* Whether to enable streaming of audit events.
|
|
4520
|
+
*/
|
|
4521
|
+
auditEnabled: boolean;
|
|
4522
|
+
/**
|
|
4523
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
4524
|
+
*/
|
|
4525
|
+
auditFilters: outputs.ProjectConnectorsOpentelemetryAuditFilter[];
|
|
4526
|
+
/**
|
|
4527
|
+
* Authentication Information
|
|
4528
|
+
*/
|
|
4529
|
+
authentication: outputs.ProjectConnectorsOpentelemetryAuthentication;
|
|
4530
|
+
/**
|
|
4531
|
+
* A description of what your connector is used for.
|
|
4532
|
+
*/
|
|
4533
|
+
description: string;
|
|
4534
|
+
/**
|
|
4535
|
+
* The OTLP endpoint URL.
|
|
4536
|
+
*/
|
|
4537
|
+
endpoint: string;
|
|
4538
|
+
/**
|
|
4539
|
+
* The headers to send with the request
|
|
4540
|
+
*/
|
|
4541
|
+
headers: {
|
|
4542
|
+
[key: string]: string;
|
|
4543
|
+
};
|
|
4544
|
+
id: string;
|
|
4545
|
+
/**
|
|
4546
|
+
* Will ignore certificate errors raised by the client
|
|
4547
|
+
*/
|
|
4548
|
+
insecure: boolean;
|
|
4549
|
+
/**
|
|
4550
|
+
* A custom name for your connector.
|
|
4551
|
+
*/
|
|
4552
|
+
name: string;
|
|
4553
|
+
/**
|
|
4554
|
+
* Protocol to use for OTLP: http or grpc.
|
|
4555
|
+
*/
|
|
4556
|
+
protocol: string;
|
|
4557
|
+
/**
|
|
4558
|
+
* Whether to send troubleshooting events.
|
|
4559
|
+
*/
|
|
4560
|
+
troubleshootLogEnabled: boolean;
|
|
4561
|
+
}
|
|
4562
|
+
export interface ProjectConnectorsOpentelemetryAuditFilter {
|
|
4563
|
+
/**
|
|
4564
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
4565
|
+
*/
|
|
4566
|
+
key: string;
|
|
4567
|
+
/**
|
|
4568
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
4569
|
+
*/
|
|
4570
|
+
operator: string;
|
|
4571
|
+
/**
|
|
4572
|
+
* The list of values to match against for the filter.
|
|
4573
|
+
*/
|
|
4574
|
+
values: string[];
|
|
4575
|
+
}
|
|
4576
|
+
export interface ProjectConnectorsOpentelemetryAuthentication {
|
|
4577
|
+
/**
|
|
4578
|
+
* API key authentication configuration.
|
|
4579
|
+
*/
|
|
4580
|
+
apiKey: outputs.ProjectConnectorsOpentelemetryAuthenticationApiKey;
|
|
4581
|
+
/**
|
|
4582
|
+
* Basic authentication credentials (username and password).
|
|
4583
|
+
*/
|
|
4584
|
+
basic: outputs.ProjectConnectorsOpentelemetryAuthenticationBasic;
|
|
4585
|
+
/**
|
|
4586
|
+
* Bearer token for HTTP authentication.
|
|
4587
|
+
*/
|
|
4588
|
+
bearerToken: string;
|
|
4589
|
+
}
|
|
4590
|
+
export interface ProjectConnectorsOpentelemetryAuthenticationApiKey {
|
|
4591
|
+
/**
|
|
4592
|
+
* The API key.
|
|
4593
|
+
*/
|
|
4594
|
+
key: string;
|
|
4595
|
+
/**
|
|
4596
|
+
* The API secret.
|
|
4597
|
+
*/
|
|
4598
|
+
token: string;
|
|
4599
|
+
}
|
|
4600
|
+
export interface ProjectConnectorsOpentelemetryAuthenticationBasic {
|
|
4601
|
+
/**
|
|
4602
|
+
* Password for basic HTTP authentication.
|
|
4603
|
+
*/
|
|
4604
|
+
password: string;
|
|
4605
|
+
/**
|
|
4606
|
+
* Username for basic HTTP authentication.
|
|
4607
|
+
*/
|
|
4608
|
+
username: string;
|
|
4609
|
+
}
|
|
4610
|
+
export interface ProjectConnectorsPendo {
|
|
4611
|
+
/**
|
|
4612
|
+
* Whether to enable streaming of audit events.
|
|
4613
|
+
*/
|
|
4614
|
+
auditEnabled: boolean;
|
|
4615
|
+
/**
|
|
4616
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
4617
|
+
*/
|
|
4618
|
+
auditFilters: outputs.ProjectConnectorsPendoAuditFilter[];
|
|
4619
|
+
/**
|
|
4620
|
+
* 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.
|
|
4621
|
+
*/
|
|
4622
|
+
baseUrl: string;
|
|
4623
|
+
/**
|
|
4624
|
+
* A description of what your connector is used for.
|
|
4625
|
+
*/
|
|
4626
|
+
description: string;
|
|
4627
|
+
id: string;
|
|
4628
|
+
/**
|
|
4629
|
+
* The secret Pendo integration key Descope should use.
|
|
4630
|
+
*/
|
|
4631
|
+
integrationKey: string;
|
|
4632
|
+
/**
|
|
4633
|
+
* Whether to mask personally identifiable information in the logs.
|
|
4634
|
+
*/
|
|
4635
|
+
maskPii: boolean;
|
|
4636
|
+
/**
|
|
4637
|
+
* A custom name for your connector.
|
|
4638
|
+
*/
|
|
4639
|
+
name: string;
|
|
4640
|
+
/**
|
|
4641
|
+
* Whether to send troubleshooting events.
|
|
4642
|
+
*/
|
|
4643
|
+
troubleshootLogEnabled: boolean;
|
|
4644
|
+
}
|
|
4645
|
+
export interface ProjectConnectorsPendoAuditFilter {
|
|
4646
|
+
/**
|
|
4647
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
4648
|
+
*/
|
|
4649
|
+
key: string;
|
|
4650
|
+
/**
|
|
4651
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
4652
|
+
*/
|
|
4653
|
+
operator: string;
|
|
4654
|
+
/**
|
|
4655
|
+
* The list of values to match against for the filter.
|
|
4656
|
+
*/
|
|
4657
|
+
values: string[];
|
|
4658
|
+
}
|
|
4659
|
+
export interface ProjectConnectorsPingDirectory {
|
|
4660
|
+
/**
|
|
4661
|
+
* A description of what your connector is used for.
|
|
4662
|
+
*/
|
|
4663
|
+
description: string;
|
|
4664
|
+
/**
|
|
4665
|
+
* PingDirectory's REST API host.
|
|
4666
|
+
*/
|
|
4667
|
+
host: string;
|
|
4668
|
+
id: string;
|
|
4669
|
+
/**
|
|
4670
|
+
* A custom name for your connector.
|
|
4671
|
+
*/
|
|
4672
|
+
name: string;
|
|
4673
|
+
/**
|
|
4674
|
+
* PingDirectory's REST API port.
|
|
4675
|
+
*/
|
|
4676
|
+
port: number;
|
|
4677
|
+
}
|
|
4678
|
+
export interface ProjectConnectorsPostmark {
|
|
4679
|
+
/**
|
|
4680
|
+
* A description of what your connector is used for.
|
|
4681
|
+
*/
|
|
4682
|
+
description: string;
|
|
4683
|
+
/**
|
|
4684
|
+
* The email address that will appear in the 'From' field of the sent email
|
|
4685
|
+
*/
|
|
4686
|
+
emailFrom: string;
|
|
4687
|
+
id: string;
|
|
4688
|
+
/**
|
|
4689
|
+
* The ID of the message stream to use for the email
|
|
4690
|
+
*/
|
|
4691
|
+
messageStreamId: string;
|
|
4692
|
+
/**
|
|
4693
|
+
* A custom name for your connector.
|
|
4694
|
+
*/
|
|
4695
|
+
name: string;
|
|
4696
|
+
/**
|
|
4697
|
+
* The API token for authenticating with the Postmark server
|
|
4698
|
+
*/
|
|
4699
|
+
serverApiToken: string;
|
|
4700
|
+
}
|
|
3404
4701
|
export interface ProjectConnectorsRadar {
|
|
3405
4702
|
/**
|
|
3406
4703
|
* The address types to return.
|
|
@@ -3460,6 +4757,10 @@ export interface ProjectConnectorsRecaptcha {
|
|
|
3460
4757
|
siteKey: string;
|
|
3461
4758
|
}
|
|
3462
4759
|
export interface ProjectConnectorsRecaptchaEnterprise {
|
|
4760
|
+
/**
|
|
4761
|
+
* The user-initiated action for this assessment.
|
|
4762
|
+
*/
|
|
4763
|
+
action: string;
|
|
3463
4764
|
/**
|
|
3464
4765
|
* API key associated with the current project.
|
|
3465
4766
|
*/
|
|
@@ -3469,7 +4770,7 @@ export interface ProjectConnectorsRecaptchaEnterprise {
|
|
|
3469
4770
|
*/
|
|
3470
4771
|
assessmentScore: number;
|
|
3471
4772
|
/**
|
|
3472
|
-
*
|
|
4773
|
+
* 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
4774
|
*/
|
|
3474
4775
|
baseUrl: string;
|
|
3475
4776
|
/**
|
|
@@ -3498,15 +4799,65 @@ export interface ProjectConnectorsRecaptchaEnterprise {
|
|
|
3498
4799
|
*/
|
|
3499
4800
|
siteKey: string;
|
|
3500
4801
|
}
|
|
4802
|
+
export interface ProjectConnectorsRecaptchaV2 {
|
|
4803
|
+
/**
|
|
4804
|
+
* When override is enabled, return this score instead of calling Google.
|
|
4805
|
+
*/
|
|
4806
|
+
assessmentScore: number;
|
|
4807
|
+
/**
|
|
4808
|
+
* 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).
|
|
4809
|
+
*/
|
|
4810
|
+
botThreshold: number;
|
|
4811
|
+
/**
|
|
4812
|
+
* A description of what your connector is used for.
|
|
4813
|
+
*/
|
|
4814
|
+
description: string;
|
|
4815
|
+
id: string;
|
|
4816
|
+
/**
|
|
4817
|
+
* A custom name for your connector.
|
|
4818
|
+
*/
|
|
4819
|
+
name: string;
|
|
4820
|
+
/**
|
|
4821
|
+
* Override the default assessment model. Intended for automated testing only.
|
|
4822
|
+
*/
|
|
4823
|
+
overrideAssessment: boolean;
|
|
4824
|
+
/**
|
|
4825
|
+
* The secret key used to verify the user's response with Google siteverify.
|
|
4826
|
+
*/
|
|
4827
|
+
secretKey: string;
|
|
4828
|
+
/**
|
|
4829
|
+
* The reCAPTCHA v2 site key from the Google reCAPTCHA admin console (checkbox / "I'm not a robot" type).
|
|
4830
|
+
*/
|
|
4831
|
+
siteKey: string;
|
|
4832
|
+
}
|
|
3501
4833
|
export interface ProjectConnectorsRekognition {
|
|
3502
4834
|
/**
|
|
3503
4835
|
* The AWS access key ID
|
|
3504
4836
|
*/
|
|
3505
4837
|
accessKeyId: string;
|
|
3506
4838
|
/**
|
|
3507
|
-
* The collection to store registered users in. Should match `[a-zA-Z0-9_.-]+` pattern. Changing this will cause losing existing users.
|
|
4839
|
+
* The collection to store registered users in. Should match `[a-zA-Z0-9_.-]+` pattern. Changing this will cause losing existing users.
|
|
4840
|
+
*/
|
|
4841
|
+
collectionId: string;
|
|
4842
|
+
/**
|
|
4843
|
+
* A description of what your connector is used for.
|
|
4844
|
+
*/
|
|
4845
|
+
description: string;
|
|
4846
|
+
id: string;
|
|
4847
|
+
/**
|
|
4848
|
+
* A custom name for your connector.
|
|
4849
|
+
*/
|
|
4850
|
+
name: string;
|
|
4851
|
+
/**
|
|
4852
|
+
* The AWS secret access key
|
|
4853
|
+
*/
|
|
4854
|
+
secretAccessKey: string;
|
|
4855
|
+
}
|
|
4856
|
+
export interface ProjectConnectorsRndReassigned {
|
|
4857
|
+
/**
|
|
4858
|
+
* Your RND company ID (e.g., C038612852). Retrieve this from your RND account under Account → Company → Company ID.
|
|
3508
4859
|
*/
|
|
3509
|
-
|
|
4860
|
+
companyId: string;
|
|
3510
4861
|
/**
|
|
3511
4862
|
* A description of what your connector is used for.
|
|
3512
4863
|
*/
|
|
@@ -3517,9 +4868,9 @@ export interface ProjectConnectorsRekognition {
|
|
|
3517
4868
|
*/
|
|
3518
4869
|
name: string;
|
|
3519
4870
|
/**
|
|
3520
|
-
*
|
|
4871
|
+
* Your RND refresh token for authentication. Retrieve this from your RND account under Account → API Credentials.
|
|
3521
4872
|
*/
|
|
3522
|
-
|
|
4873
|
+
refreshToken: string;
|
|
3523
4874
|
}
|
|
3524
4875
|
export interface ProjectConnectorsSalesforce {
|
|
3525
4876
|
/**
|
|
@@ -3602,6 +4953,81 @@ export interface ProjectConnectorsSardine {
|
|
|
3602
4953
|
*/
|
|
3603
4954
|
name: string;
|
|
3604
4955
|
}
|
|
4956
|
+
export interface ProjectConnectorsScim {
|
|
4957
|
+
/**
|
|
4958
|
+
* Authentication credentials used when sending requests to the SCIM endpoint.
|
|
4959
|
+
*/
|
|
4960
|
+
authentication: outputs.ProjectConnectorsScimAuthentication;
|
|
4961
|
+
/**
|
|
4962
|
+
* The base URL of the SCIM v2 endpoint that user provisioning events will be sent to.
|
|
4963
|
+
*/
|
|
4964
|
+
baseUrl: string;
|
|
4965
|
+
/**
|
|
4966
|
+
* A description of what your connector is used for.
|
|
4967
|
+
*/
|
|
4968
|
+
description: string;
|
|
4969
|
+
/**
|
|
4970
|
+
* Whether to disable this SCIM connector. When disabled, provisioning events will not be sent to the configured endpoint.
|
|
4971
|
+
*/
|
|
4972
|
+
disabled: boolean;
|
|
4973
|
+
/**
|
|
4974
|
+
* The ID of the federated SSO application this SCIM connector is associated with.
|
|
4975
|
+
*/
|
|
4976
|
+
federatedAppId: string;
|
|
4977
|
+
/**
|
|
4978
|
+
* Custom HTTP headers to send with each provisioning request.
|
|
4979
|
+
*/
|
|
4980
|
+
headers: {
|
|
4981
|
+
[key: string]: string;
|
|
4982
|
+
};
|
|
4983
|
+
/**
|
|
4984
|
+
* 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.
|
|
4985
|
+
*/
|
|
4986
|
+
hmacSecret: string;
|
|
4987
|
+
id: string;
|
|
4988
|
+
/**
|
|
4989
|
+
* Will ignore certificate errors raised by the client.
|
|
4990
|
+
*/
|
|
4991
|
+
insecure: boolean;
|
|
4992
|
+
/**
|
|
4993
|
+
* A custom name for your connector.
|
|
4994
|
+
*/
|
|
4995
|
+
name: string;
|
|
4996
|
+
}
|
|
4997
|
+
export interface ProjectConnectorsScimAuthentication {
|
|
4998
|
+
/**
|
|
4999
|
+
* API key authentication configuration.
|
|
5000
|
+
*/
|
|
5001
|
+
apiKey: outputs.ProjectConnectorsScimAuthenticationApiKey;
|
|
5002
|
+
/**
|
|
5003
|
+
* Basic authentication credentials (username and password).
|
|
5004
|
+
*/
|
|
5005
|
+
basic: outputs.ProjectConnectorsScimAuthenticationBasic;
|
|
5006
|
+
/**
|
|
5007
|
+
* Bearer token for HTTP authentication.
|
|
5008
|
+
*/
|
|
5009
|
+
bearerToken: string;
|
|
5010
|
+
}
|
|
5011
|
+
export interface ProjectConnectorsScimAuthenticationApiKey {
|
|
5012
|
+
/**
|
|
5013
|
+
* The API key.
|
|
5014
|
+
*/
|
|
5015
|
+
key: string;
|
|
5016
|
+
/**
|
|
5017
|
+
* The API secret.
|
|
5018
|
+
*/
|
|
5019
|
+
token: string;
|
|
5020
|
+
}
|
|
5021
|
+
export interface ProjectConnectorsScimAuthenticationBasic {
|
|
5022
|
+
/**
|
|
5023
|
+
* Password for basic HTTP authentication.
|
|
5024
|
+
*/
|
|
5025
|
+
password: string;
|
|
5026
|
+
/**
|
|
5027
|
+
* Username for basic HTTP authentication.
|
|
5028
|
+
*/
|
|
5029
|
+
username: string;
|
|
5030
|
+
}
|
|
3605
5031
|
export interface ProjectConnectorsSe {
|
|
3606
5032
|
/**
|
|
3607
5033
|
* AWS Access key ID.
|
|
@@ -3857,6 +5283,163 @@ export interface ProjectConnectorsSn {
|
|
|
3857
5283
|
*/
|
|
3858
5284
|
templateId: string;
|
|
3859
5285
|
}
|
|
5286
|
+
export interface ProjectConnectorsSnowflake {
|
|
5287
|
+
/**
|
|
5288
|
+
* A Snowflake Programmatic Access Token (PAT). The token's user must have CREATE DATABASE privileges.
|
|
5289
|
+
*/
|
|
5290
|
+
apiKey: string;
|
|
5291
|
+
/**
|
|
5292
|
+
* Whether to enable streaming of audit events.
|
|
5293
|
+
*/
|
|
5294
|
+
auditEnabled: boolean;
|
|
5295
|
+
/**
|
|
5296
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
5297
|
+
*/
|
|
5298
|
+
auditFilters: outputs.ProjectConnectorsSnowflakeAuditFilter[];
|
|
5299
|
+
/**
|
|
5300
|
+
* The table to write audit events to. Defaults to `DESCOPE_AUDIT_LOGS`.
|
|
5301
|
+
*/
|
|
5302
|
+
auditTable: string;
|
|
5303
|
+
/**
|
|
5304
|
+
* The Snowflake database to use. Defaults to `DESCOPE_EXPORT_DB`.
|
|
5305
|
+
*/
|
|
5306
|
+
database: string;
|
|
5307
|
+
/**
|
|
5308
|
+
* A description of what your connector is used for.
|
|
5309
|
+
*/
|
|
5310
|
+
description: string;
|
|
5311
|
+
id: string;
|
|
5312
|
+
/**
|
|
5313
|
+
* Whether to mask personally identifiable information in the logs.
|
|
5314
|
+
*/
|
|
5315
|
+
maskPii: boolean;
|
|
5316
|
+
/**
|
|
5317
|
+
* 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.
|
|
5318
|
+
*/
|
|
5319
|
+
minFlushIntervalMinutes: number;
|
|
5320
|
+
/**
|
|
5321
|
+
* A custom name for your connector.
|
|
5322
|
+
*/
|
|
5323
|
+
name: string;
|
|
5324
|
+
/**
|
|
5325
|
+
* The schema within the database. Defaults to `PUBLIC`.
|
|
5326
|
+
*/
|
|
5327
|
+
schema: string;
|
|
5328
|
+
/**
|
|
5329
|
+
* Your Snowflake account URL, e.g. `https://<org>-<account>.snowflakecomputing.com`.
|
|
5330
|
+
*/
|
|
5331
|
+
site: string;
|
|
5332
|
+
/**
|
|
5333
|
+
* Whether to send troubleshooting events.
|
|
5334
|
+
*/
|
|
5335
|
+
troubleshootLogEnabled: boolean;
|
|
5336
|
+
/**
|
|
5337
|
+
* The Snowflake warehouse to use. Defaults to `COMPUTE_WH`.
|
|
5338
|
+
*/
|
|
5339
|
+
warehouse: string;
|
|
5340
|
+
}
|
|
5341
|
+
export interface ProjectConnectorsSnowflakeAuditFilter {
|
|
5342
|
+
/**
|
|
5343
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
5344
|
+
*/
|
|
5345
|
+
key: string;
|
|
5346
|
+
/**
|
|
5347
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
5348
|
+
*/
|
|
5349
|
+
operator: string;
|
|
5350
|
+
/**
|
|
5351
|
+
* The list of values to match against for the filter.
|
|
5352
|
+
*/
|
|
5353
|
+
values: string[];
|
|
5354
|
+
}
|
|
5355
|
+
export interface ProjectConnectorsSplunk {
|
|
5356
|
+
/**
|
|
5357
|
+
* Whether to enable streaming of audit events.
|
|
5358
|
+
*/
|
|
5359
|
+
auditEnabled: boolean;
|
|
5360
|
+
/**
|
|
5361
|
+
* Specify which events will be sent to the external audit service (including tenant selection).
|
|
5362
|
+
*/
|
|
5363
|
+
auditFilters: outputs.ProjectConnectorsSplunkAuditFilter[];
|
|
5364
|
+
/**
|
|
5365
|
+
* A description of what your connector is used for.
|
|
5366
|
+
*/
|
|
5367
|
+
description: string;
|
|
5368
|
+
/**
|
|
5369
|
+
* An HTTP Event Collector token configured on your Splunk project.
|
|
5370
|
+
*/
|
|
5371
|
+
hecToken: string;
|
|
5372
|
+
/**
|
|
5373
|
+
* The URL to be used accessing your Splunk system, including the appropriate port
|
|
5374
|
+
*/
|
|
5375
|
+
hecUrl: string;
|
|
5376
|
+
id: string;
|
|
5377
|
+
/**
|
|
5378
|
+
* An optional index to use for all sent events
|
|
5379
|
+
*/
|
|
5380
|
+
index: string;
|
|
5381
|
+
/**
|
|
5382
|
+
* A custom name for your connector.
|
|
5383
|
+
*/
|
|
5384
|
+
name: string;
|
|
5385
|
+
/**
|
|
5386
|
+
* Whether to send troubleshooting events.
|
|
5387
|
+
*/
|
|
5388
|
+
troubleshootLogEnabled: boolean;
|
|
5389
|
+
}
|
|
5390
|
+
export interface ProjectConnectorsSplunkAuditFilter {
|
|
5391
|
+
/**
|
|
5392
|
+
* The field name to filter on (either 'actions' or 'tenants').
|
|
5393
|
+
*/
|
|
5394
|
+
key: string;
|
|
5395
|
+
/**
|
|
5396
|
+
* The filter operation to apply ('includes' or 'excludes').
|
|
5397
|
+
*/
|
|
5398
|
+
operator: string;
|
|
5399
|
+
/**
|
|
5400
|
+
* The list of values to match against for the filter.
|
|
5401
|
+
*/
|
|
5402
|
+
values: string[];
|
|
5403
|
+
}
|
|
5404
|
+
export interface ProjectConnectorsSql {
|
|
5405
|
+
/**
|
|
5406
|
+
* The database name.
|
|
5407
|
+
*/
|
|
5408
|
+
databaseName: string;
|
|
5409
|
+
/**
|
|
5410
|
+
* A description of what your connector is used for.
|
|
5411
|
+
*/
|
|
5412
|
+
description: string;
|
|
5413
|
+
/**
|
|
5414
|
+
* The database engine type.
|
|
5415
|
+
*/
|
|
5416
|
+
engineName: string;
|
|
5417
|
+
/**
|
|
5418
|
+
* The database host.
|
|
5419
|
+
*/
|
|
5420
|
+
host: string;
|
|
5421
|
+
id: string;
|
|
5422
|
+
/**
|
|
5423
|
+
* A custom name for your connector.
|
|
5424
|
+
*/
|
|
5425
|
+
name: string;
|
|
5426
|
+
/**
|
|
5427
|
+
* The database password.
|
|
5428
|
+
*/
|
|
5429
|
+
password: string;
|
|
5430
|
+
/**
|
|
5431
|
+
* The database port. If not specified, the default port for the selected engine will be used.
|
|
5432
|
+
*/
|
|
5433
|
+
port: number;
|
|
5434
|
+
/**
|
|
5435
|
+
* The Oracle service name (required for Oracle only).
|
|
5436
|
+
*/
|
|
5437
|
+
serviceName: string;
|
|
5438
|
+
/**
|
|
5439
|
+
* The database username.
|
|
5440
|
+
*/
|
|
5441
|
+
username: string;
|
|
5442
|
+
}
|
|
3860
5443
|
export interface ProjectConnectorsSumologic {
|
|
3861
5444
|
/**
|
|
3862
5445
|
* Whether to enable streaming of audit events.
|
|
@@ -4104,6 +5687,60 @@ export interface ProjectConnectorsTwilioVerifyAuthentication {
|
|
|
4104
5687
|
*/
|
|
4105
5688
|
authToken: string;
|
|
4106
5689
|
}
|
|
5690
|
+
export interface ProjectConnectorsUnibeam {
|
|
5691
|
+
/**
|
|
5692
|
+
* Unibeam API base URL.
|
|
5693
|
+
*/
|
|
5694
|
+
baseUrl: string;
|
|
5695
|
+
/**
|
|
5696
|
+
* OAuth2 client ID for authentication.
|
|
5697
|
+
*/
|
|
5698
|
+
clientId: string;
|
|
5699
|
+
/**
|
|
5700
|
+
* OAuth2 client secret for authentication.
|
|
5701
|
+
*/
|
|
5702
|
+
clientSecret: string;
|
|
5703
|
+
/**
|
|
5704
|
+
* Your Unibeam customer ID.
|
|
5705
|
+
*/
|
|
5706
|
+
customerId: string;
|
|
5707
|
+
/**
|
|
5708
|
+
* Default message to display when no message is provided in the command.
|
|
5709
|
+
*/
|
|
5710
|
+
defaultMessage: string;
|
|
5711
|
+
/**
|
|
5712
|
+
* A description of what your connector is used for.
|
|
5713
|
+
*/
|
|
5714
|
+
description: string;
|
|
5715
|
+
/**
|
|
5716
|
+
* HMAC secret supplied by Unibeam for securing communications.
|
|
5717
|
+
*/
|
|
5718
|
+
hmacSecret: string;
|
|
5719
|
+
id: string;
|
|
5720
|
+
/**
|
|
5721
|
+
* A custom name for your connector.
|
|
5722
|
+
*/
|
|
5723
|
+
name: string;
|
|
5724
|
+
}
|
|
5725
|
+
export interface ProjectConnectorsZerobounce {
|
|
5726
|
+
/**
|
|
5727
|
+
* The ZeroBounce API key.
|
|
5728
|
+
*/
|
|
5729
|
+
apiKey: string;
|
|
5730
|
+
/**
|
|
5731
|
+
* A description of what your connector is used for.
|
|
5732
|
+
*/
|
|
5733
|
+
description: string;
|
|
5734
|
+
id: string;
|
|
5735
|
+
/**
|
|
5736
|
+
* A custom name for your connector.
|
|
5737
|
+
*/
|
|
5738
|
+
name: string;
|
|
5739
|
+
/**
|
|
5740
|
+
* ZeroBounce platform region.
|
|
5741
|
+
*/
|
|
5742
|
+
region: string;
|
|
5743
|
+
}
|
|
4107
5744
|
export interface ProjectFlows {
|
|
4108
5745
|
/**
|
|
4109
5746
|
* The JSON data defining the authentication flow configuration, including metadata, screens, contents, and references.
|
|
@@ -4192,6 +5829,10 @@ export interface ProjectJwtTemplates {
|
|
|
4192
5829
|
userTemplates: outputs.ProjectJwtTemplatesUserTemplate[];
|
|
4193
5830
|
}
|
|
4194
5831
|
export interface ProjectJwtTemplatesAccessKeyTemplate {
|
|
5832
|
+
/**
|
|
5833
|
+
* When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
|
|
5834
|
+
*/
|
|
5835
|
+
addJtiClaim: boolean;
|
|
4195
5836
|
/**
|
|
4196
5837
|
* The authorization claims format - `default`, `tenantOnly` or `none`. Read more about schema types [here](https://docs.descope.com/project-settings/jwt-templates).
|
|
4197
5838
|
*/
|
|
@@ -4216,17 +5857,29 @@ export interface ProjectJwtTemplatesAccessKeyTemplate {
|
|
|
4216
5857
|
* Whether to enforce that the JWT issuer matches the project configuration.
|
|
4217
5858
|
*/
|
|
4218
5859
|
enforceIssuer: boolean;
|
|
5860
|
+
/**
|
|
5861
|
+
* When enabled, permissions will not be included in the JWT token.
|
|
5862
|
+
*/
|
|
5863
|
+
excludePermissionClaim: boolean;
|
|
4219
5864
|
id: string;
|
|
4220
5865
|
/**
|
|
4221
5866
|
* Name of the JWT Template.
|
|
4222
5867
|
*/
|
|
4223
5868
|
name: string;
|
|
5869
|
+
/**
|
|
5870
|
+
* 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.
|
|
5871
|
+
*/
|
|
5872
|
+
overrideSubjectClaim: boolean;
|
|
4224
5873
|
/**
|
|
4225
5874
|
* 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
5875
|
*/
|
|
4227
5876
|
template: string;
|
|
4228
5877
|
}
|
|
4229
5878
|
export interface ProjectJwtTemplatesUserTemplate {
|
|
5879
|
+
/**
|
|
5880
|
+
* When enabled, a unique JWT ID (jti) claim will be added to the token for tracking and preventing replay attacks.
|
|
5881
|
+
*/
|
|
5882
|
+
addJtiClaim: boolean;
|
|
4230
5883
|
/**
|
|
4231
5884
|
* The authorization claims format - `default`, `tenantOnly` or `none`. Read more about schema types [here](https://docs.descope.com/project-settings/jwt-templates).
|
|
4232
5885
|
*/
|
|
@@ -4251,11 +5904,19 @@ export interface ProjectJwtTemplatesUserTemplate {
|
|
|
4251
5904
|
* Whether to enforce that the JWT issuer matches the project configuration.
|
|
4252
5905
|
*/
|
|
4253
5906
|
enforceIssuer: boolean;
|
|
5907
|
+
/**
|
|
5908
|
+
* When enabled, permissions will not be included in the JWT token.
|
|
5909
|
+
*/
|
|
5910
|
+
excludePermissionClaim: boolean;
|
|
4254
5911
|
id: string;
|
|
4255
5912
|
/**
|
|
4256
5913
|
* Name of the JWT Template.
|
|
4257
5914
|
*/
|
|
4258
5915
|
name: string;
|
|
5916
|
+
/**
|
|
5917
|
+
* 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.
|
|
5918
|
+
*/
|
|
5919
|
+
overrideSubjectClaim: boolean;
|
|
4259
5920
|
/**
|
|
4260
5921
|
* 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
5922
|
*/
|
|
@@ -4357,6 +6018,10 @@ export interface ProjectProjectSettings {
|
|
|
4357
6018
|
* 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
6019
|
*/
|
|
4359
6020
|
stepUpTokenExpiration: string;
|
|
6021
|
+
/**
|
|
6022
|
+
* 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.
|
|
6023
|
+
*/
|
|
6024
|
+
tenantUserIsolation: boolean;
|
|
4360
6025
|
/**
|
|
4361
6026
|
* 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
6027
|
*/
|
|
@@ -4379,6 +6044,10 @@ export interface ProjectProjectSettings {
|
|
|
4379
6044
|
userJwtTemplate: string;
|
|
4380
6045
|
}
|
|
4381
6046
|
export interface ProjectProjectSettingsSessionMigration {
|
|
6047
|
+
/**
|
|
6048
|
+
* An API token for the vendor, required when `vendor` is set to `okta`.
|
|
6049
|
+
*/
|
|
6050
|
+
apiToken: string;
|
|
4382
6051
|
/**
|
|
4383
6052
|
* The audience value if needed by the vendor.
|
|
4384
6053
|
*/
|
|
@@ -4399,11 +6068,29 @@ export interface ProjectProjectSettingsSessionMigration {
|
|
|
4399
6068
|
* A set of attributes from the vendor's user that should be used to match with the Descope user's login ID.
|
|
4400
6069
|
*/
|
|
4401
6070
|
loginidMatchedAttributes: string[];
|
|
6071
|
+
/**
|
|
6072
|
+
* A list of attribute mappings from the external vendor's user to Descope user attributes.
|
|
6073
|
+
*/
|
|
6074
|
+
userMappings: outputs.ProjectProjectSettingsSessionMigrationUserMapping[];
|
|
6075
|
+
/**
|
|
6076
|
+
* The type of user synchronization to perform. Valid values are `matchOnly` (match existing users only) and `jit` (just-in-time provisioning).
|
|
6077
|
+
*/
|
|
6078
|
+
userSyncType: string;
|
|
4402
6079
|
/**
|
|
4403
6080
|
* The name of the vendor the sessions are migrated from, in all lowercase.
|
|
4404
6081
|
*/
|
|
4405
6082
|
vendor: string;
|
|
4406
6083
|
}
|
|
6084
|
+
export interface ProjectProjectSettingsSessionMigrationUserMapping {
|
|
6085
|
+
/**
|
|
6086
|
+
* The Descope user attribute to map the external key to.
|
|
6087
|
+
*/
|
|
6088
|
+
descopeKey: string;
|
|
6089
|
+
/**
|
|
6090
|
+
* The attribute key in the external vendor's user object.
|
|
6091
|
+
*/
|
|
6092
|
+
externalKey: string;
|
|
6093
|
+
}
|
|
4407
6094
|
export interface ProjectStyles {
|
|
4408
6095
|
/**
|
|
4409
6096
|
* The JSON data defining the visual styling and theme configuration used for authentication, widgets, etc.
|
|
@@ -4416,3 +6103,4 @@ export interface ProjectWidgets {
|
|
|
4416
6103
|
*/
|
|
4417
6104
|
data: string;
|
|
4418
6105
|
}
|
|
6106
|
+
//# sourceMappingURL=output.d.ts.map
|