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