@onkernel/sdk 0.32.0 → 0.33.0
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/CHANGELOG.md +16 -0
- package/client.d.mts +0 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +0 -3
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/auth/auth.d.mts +2 -2
- package/resources/auth/auth.d.mts.map +1 -1
- package/resources/auth/auth.d.ts +2 -2
- package/resources/auth/auth.d.ts.map +1 -1
- package/resources/auth/auth.js.map +1 -1
- package/resources/auth/auth.mjs.map +1 -1
- package/resources/auth/connections.d.mts +164 -59
- package/resources/auth/connections.d.mts.map +1 -1
- package/resources/auth/connections.d.ts +164 -59
- package/resources/auth/connections.d.ts.map +1 -1
- package/resources/auth/connections.js +12 -17
- package/resources/auth/connections.js.map +1 -1
- package/resources/auth/connections.mjs +12 -17
- package/resources/auth/connections.mjs.map +1 -1
- package/resources/auth/index.d.mts +1 -1
- package/resources/auth/index.d.mts.map +1 -1
- package/resources/auth/index.d.ts +1 -1
- package/resources/auth/index.d.ts.map +1 -1
- package/resources/auth/index.js.map +1 -1
- package/resources/auth/index.mjs.map +1 -1
- package/resources/credentials.d.mts +4 -0
- package/resources/credentials.d.mts.map +1 -1
- package/resources/credentials.d.ts +4 -0
- package/resources/credentials.d.ts.map +1 -1
- package/resources/index.d.mts +0 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +0 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -1
- package/resources/index.mjs.map +1 -1
- package/src/client.ts +0 -5
- package/src/resources/auth/auth.ts +0 -2
- package/src/resources/auth/connections.ts +185 -60
- package/src/resources/auth/index.ts +0 -1
- package/src/resources/credentials.ts +5 -0
- package/src/resources/index.ts +0 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/agents/agents.d.mts +0 -10
- package/resources/agents/agents.d.mts.map +0 -1
- package/resources/agents/agents.d.ts +0 -10
- package/resources/agents/agents.d.ts.map +0 -1
- package/resources/agents/agents.js +0 -17
- package/resources/agents/agents.js.map +0 -1
- package/resources/agents/agents.mjs +0 -12
- package/resources/agents/agents.mjs.map +0 -1
- package/resources/agents/auth/auth.d.mts +0 -474
- package/resources/agents/auth/auth.d.mts.map +0 -1
- package/resources/agents/auth/auth.d.ts +0 -474
- package/resources/agents/auth/auth.d.ts.map +0 -1
- package/resources/agents/auth/auth.js +0 -66
- package/resources/agents/auth/auth.js.map +0 -1
- package/resources/agents/auth/auth.mjs +0 -61
- package/resources/agents/auth/auth.mjs.map +0 -1
- package/resources/agents/auth/index.d.mts +0 -3
- package/resources/agents/auth/index.d.mts.map +0 -1
- package/resources/agents/auth/index.d.ts +0 -3
- package/resources/agents/auth/index.d.ts.map +0 -1
- package/resources/agents/auth/index.js +0 -9
- package/resources/agents/auth/index.js.map +0 -1
- package/resources/agents/auth/index.mjs +0 -4
- package/resources/agents/auth/index.mjs.map +0 -1
- package/resources/agents/auth/invocations.d.mts +0 -96
- package/resources/agents/auth/invocations.d.mts.map +0 -1
- package/resources/agents/auth/invocations.d.ts +0 -96
- package/resources/agents/auth/invocations.d.ts.map +0 -1
- package/resources/agents/auth/invocations.js +0 -50
- package/resources/agents/auth/invocations.js.map +0 -1
- package/resources/agents/auth/invocations.mjs +0 -46
- package/resources/agents/auth/invocations.mjs.map +0 -1
- package/resources/agents/auth.d.mts +0 -2
- package/resources/agents/auth.d.mts.map +0 -1
- package/resources/agents/auth.d.ts +0 -2
- package/resources/agents/auth.d.ts.map +0 -1
- package/resources/agents/auth.js +0 -6
- package/resources/agents/auth.js.map +0 -1
- package/resources/agents/auth.mjs +0 -3
- package/resources/agents/auth.mjs.map +0 -1
- package/resources/agents/index.d.mts +0 -3
- package/resources/agents/index.d.mts.map +0 -1
- package/resources/agents/index.d.ts +0 -3
- package/resources/agents/index.d.ts.map +0 -1
- package/resources/agents/index.js +0 -9
- package/resources/agents/index.js.map +0 -1
- package/resources/agents/index.mjs +0 -4
- package/resources/agents/index.mjs.map +0 -1
- package/resources/agents.d.mts +0 -2
- package/resources/agents.d.mts.map +0 -1
- package/resources/agents.d.ts +0 -2
- package/resources/agents.d.ts.map +0 -1
- package/resources/agents.js +0 -6
- package/resources/agents.js.map +0 -1
- package/resources/agents.mjs +0 -3
- package/resources/agents.mjs.map +0 -1
- package/src/resources/agents/agents.ts +0 -39
- package/src/resources/agents/auth/auth.ts +0 -599
- package/src/resources/agents/auth/index.ts +0 -22
- package/src/resources/agents/auth/invocations.ts +0 -137
- package/src/resources/agents/auth.ts +0 -3
- package/src/resources/agents/index.ts +0 -16
- package/src/resources/agents.ts +0 -3
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import * as Shared from "../shared.js";
|
|
3
|
-
import * as AuthAPI from "../agents/auth/auth.js";
|
|
4
3
|
import { APIPromise } from "../../core/api-promise.js";
|
|
5
4
|
import { OffsetPagination, type OffsetPaginationParams, PagePromise } from "../../core/pagination.js";
|
|
6
5
|
import { Stream } from "../../core/streaming.js";
|
|
7
6
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
8
7
|
export declare class Connections extends APIResource {
|
|
9
8
|
/**
|
|
10
|
-
* Creates
|
|
11
|
-
* Conflict if
|
|
9
|
+
* Creates an auth connection for a profile and domain combination. Returns 409
|
|
10
|
+
* Conflict if an auth connection already exists for the given profile and domain.
|
|
12
11
|
*
|
|
13
12
|
* @example
|
|
14
13
|
* ```ts
|
|
@@ -20,8 +19,8 @@ export declare class Connections extends APIResource {
|
|
|
20
19
|
*/
|
|
21
20
|
create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise<ManagedAuth>;
|
|
22
21
|
/**
|
|
23
|
-
* Retrieve
|
|
24
|
-
* progress.
|
|
22
|
+
* Retrieve an auth connection by its ID. Includes current flow state if a login is
|
|
23
|
+
* in progress.
|
|
25
24
|
*
|
|
26
25
|
* @example
|
|
27
26
|
* ```ts
|
|
@@ -32,7 +31,7 @@ export declare class Connections extends APIResource {
|
|
|
32
31
|
*/
|
|
33
32
|
retrieve(id: string, options?: RequestOptions): APIPromise<ManagedAuth>;
|
|
34
33
|
/**
|
|
35
|
-
* List
|
|
34
|
+
* List auth connections with optional filters for profile_name and domain.
|
|
36
35
|
*
|
|
37
36
|
* @example
|
|
38
37
|
* ```ts
|
|
@@ -44,9 +43,9 @@ export declare class Connections extends APIResource {
|
|
|
44
43
|
*/
|
|
45
44
|
list(query?: ConnectionListParams | null | undefined, options?: RequestOptions): PagePromise<ManagedAuthsOffsetPagination, ManagedAuth>;
|
|
46
45
|
/**
|
|
47
|
-
* Deletes
|
|
46
|
+
* Deletes an auth connection and terminates its workflow. This will:
|
|
48
47
|
*
|
|
49
|
-
* - Delete the
|
|
48
|
+
* - Delete the auth connection record
|
|
50
49
|
* - Terminate the Temporal workflow
|
|
51
50
|
* - Cancel any in-progress login flows
|
|
52
51
|
*
|
|
@@ -68,8 +67,8 @@ export declare class Connections extends APIResource {
|
|
|
68
67
|
*/
|
|
69
68
|
follow(id: string, options?: RequestOptions): APIPromise<Stream<ConnectionFollowResponse>>;
|
|
70
69
|
/**
|
|
71
|
-
* Starts a login flow for the
|
|
72
|
-
* for the user to complete authentication, or triggers automatic re-auth if
|
|
70
|
+
* Starts a login flow for the auth connection. Returns immediately with a hosted
|
|
71
|
+
* URL for the user to complete authentication, or triggers automatic re-auth if
|
|
73
72
|
* credentials are stored.
|
|
74
73
|
*
|
|
75
74
|
* @example
|
|
@@ -81,38 +80,24 @@ export declare class Connections extends APIResource {
|
|
|
81
80
|
*/
|
|
82
81
|
login(id: string, body?: ConnectionLoginParams | null | undefined, options?: RequestOptions): APIPromise<LoginResponse>;
|
|
83
82
|
/**
|
|
84
|
-
* Submits field values for the login form. Poll the
|
|
85
|
-
* and get results.
|
|
83
|
+
* Submits field values for the login form. Poll the auth connection to track
|
|
84
|
+
* progress and get results.
|
|
86
85
|
*
|
|
87
86
|
* @example
|
|
88
87
|
* ```ts
|
|
89
88
|
* const submitFieldsResponse =
|
|
90
|
-
* await client.auth.connections.submit('id'
|
|
91
|
-
* fields: {
|
|
92
|
-
* email: 'user@example.com',
|
|
93
|
-
* password: 'secret',
|
|
94
|
-
* },
|
|
95
|
-
* });
|
|
89
|
+
* await client.auth.connections.submit('id');
|
|
96
90
|
* ```
|
|
97
91
|
*/
|
|
98
92
|
submit(id: string, body: ConnectionSubmitParams, options?: RequestOptions): APIPromise<SubmitFieldsResponse>;
|
|
99
93
|
}
|
|
100
94
|
export type ManagedAuthsOffsetPagination = OffsetPagination<ManagedAuth>;
|
|
101
|
-
/**
|
|
102
|
-
* Request to start a login flow
|
|
103
|
-
*/
|
|
104
|
-
export interface LoginRequest {
|
|
105
|
-
/**
|
|
106
|
-
* If provided, saves credentials under this name upon successful login
|
|
107
|
-
*/
|
|
108
|
-
save_credential_as?: string;
|
|
109
|
-
}
|
|
110
95
|
/**
|
|
111
96
|
* Response from starting a login flow
|
|
112
97
|
*/
|
|
113
98
|
export interface LoginResponse {
|
|
114
99
|
/**
|
|
115
|
-
*
|
|
100
|
+
* Auth connection ID
|
|
116
101
|
*/
|
|
117
102
|
id: string;
|
|
118
103
|
/**
|
|
@@ -143,7 +128,7 @@ export interface LoginResponse {
|
|
|
143
128
|
*/
|
|
144
129
|
export interface ManagedAuth {
|
|
145
130
|
/**
|
|
146
|
-
* Unique identifier for the
|
|
131
|
+
* Unique identifier for the auth connection
|
|
147
132
|
*/
|
|
148
133
|
id: string;
|
|
149
134
|
/**
|
|
@@ -151,9 +136,14 @@ export interface ManagedAuth {
|
|
|
151
136
|
*/
|
|
152
137
|
domain: string;
|
|
153
138
|
/**
|
|
154
|
-
* Name of the profile associated with this
|
|
139
|
+
* Name of the profile associated with this auth connection
|
|
155
140
|
*/
|
|
156
141
|
profile_name: string;
|
|
142
|
+
/**
|
|
143
|
+
* Whether credentials are saved after every successful login. One-time codes
|
|
144
|
+
* (TOTP, SMS, etc.) are not saved.
|
|
145
|
+
*/
|
|
146
|
+
save_credentials: boolean;
|
|
157
147
|
/**
|
|
158
148
|
* Current authentication status of the managed profile
|
|
159
149
|
*/
|
|
@@ -188,7 +178,7 @@ export interface ManagedAuth {
|
|
|
188
178
|
*/
|
|
189
179
|
can_reauth_reason?: string;
|
|
190
180
|
/**
|
|
191
|
-
* Reference to credentials for
|
|
181
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
192
182
|
*
|
|
193
183
|
* - { name } for Kernel credentials
|
|
194
184
|
* - { provider, path } for external provider item
|
|
@@ -198,7 +188,7 @@ export interface ManagedAuth {
|
|
|
198
188
|
/**
|
|
199
189
|
* Fields awaiting input (present when flow_step=awaiting_input)
|
|
200
190
|
*/
|
|
201
|
-
discovered_fields?: Array<
|
|
191
|
+
discovered_fields?: Array<ManagedAuth.DiscoveredField> | null;
|
|
202
192
|
/**
|
|
203
193
|
* Error message (present when flow_status=failed)
|
|
204
194
|
*/
|
|
@@ -227,8 +217,9 @@ export interface ManagedAuth {
|
|
|
227
217
|
/**
|
|
228
218
|
* Interval in seconds between automatic health checks. When set, the system
|
|
229
219
|
* periodically verifies the authentication status and triggers re-authentication
|
|
230
|
-
* if needed.
|
|
231
|
-
* (
|
|
220
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour). The minimum
|
|
221
|
+
* depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes),
|
|
222
|
+
* Hobbyist: 3600 (1 hour).
|
|
232
223
|
*/
|
|
233
224
|
health_check_interval?: number | null;
|
|
234
225
|
/**
|
|
@@ -256,6 +247,10 @@ export interface ManagedAuth {
|
|
|
256
247
|
* URL where the browser landed after successful login
|
|
257
248
|
*/
|
|
258
249
|
post_login_url?: string;
|
|
250
|
+
/**
|
|
251
|
+
* ID of the proxy associated with this connection, if any.
|
|
252
|
+
*/
|
|
253
|
+
proxy_id?: string;
|
|
259
254
|
/**
|
|
260
255
|
* SSO provider being used (e.g., google, github, microsoft)
|
|
261
256
|
*/
|
|
@@ -268,7 +263,7 @@ export interface ManagedAuth {
|
|
|
268
263
|
}
|
|
269
264
|
export declare namespace ManagedAuth {
|
|
270
265
|
/**
|
|
271
|
-
* Reference to credentials for
|
|
266
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
272
267
|
*
|
|
273
268
|
* - { name } for Kernel credentials
|
|
274
269
|
* - { provider, path } for external provider item
|
|
@@ -292,6 +287,40 @@ export declare namespace ManagedAuth {
|
|
|
292
287
|
*/
|
|
293
288
|
provider?: string;
|
|
294
289
|
}
|
|
290
|
+
/**
|
|
291
|
+
* A discovered form field
|
|
292
|
+
*/
|
|
293
|
+
interface DiscoveredField {
|
|
294
|
+
/**
|
|
295
|
+
* Field label
|
|
296
|
+
*/
|
|
297
|
+
label: string;
|
|
298
|
+
/**
|
|
299
|
+
* Field name
|
|
300
|
+
*/
|
|
301
|
+
name: string;
|
|
302
|
+
/**
|
|
303
|
+
* CSS selector for the field
|
|
304
|
+
*/
|
|
305
|
+
selector: string;
|
|
306
|
+
/**
|
|
307
|
+
* Field type
|
|
308
|
+
*/
|
|
309
|
+
type: 'text' | 'email' | 'password' | 'tel' | 'number' | 'url' | 'code' | 'totp';
|
|
310
|
+
/**
|
|
311
|
+
* If this field is associated with an MFA option, the type of that option (e.g.,
|
|
312
|
+
* password field linked to "Enter password" option)
|
|
313
|
+
*/
|
|
314
|
+
linked_mfa_type?: 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | null;
|
|
315
|
+
/**
|
|
316
|
+
* Field placeholder
|
|
317
|
+
*/
|
|
318
|
+
placeholder?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Whether field is required
|
|
321
|
+
*/
|
|
322
|
+
required?: boolean;
|
|
323
|
+
}
|
|
295
324
|
/**
|
|
296
325
|
* An MFA method option for verification
|
|
297
326
|
*/
|
|
@@ -332,7 +361,7 @@ export declare namespace ManagedAuth {
|
|
|
332
361
|
}
|
|
333
362
|
}
|
|
334
363
|
/**
|
|
335
|
-
* Request to create
|
|
364
|
+
* Request to create an auth connection for a profile and domain
|
|
336
365
|
*/
|
|
337
366
|
export interface ManagedAuthCreateRequest {
|
|
338
367
|
/**
|
|
@@ -364,7 +393,7 @@ export interface ManagedAuthCreateRequest {
|
|
|
364
393
|
*/
|
|
365
394
|
allowed_domains?: Array<string>;
|
|
366
395
|
/**
|
|
367
|
-
* Reference to credentials for
|
|
396
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
368
397
|
*
|
|
369
398
|
* - { name } for Kernel credentials
|
|
370
399
|
* - { provider, path } for external provider item
|
|
@@ -374,8 +403,9 @@ export interface ManagedAuthCreateRequest {
|
|
|
374
403
|
/**
|
|
375
404
|
* Interval in seconds between automatic health checks. When set, the system
|
|
376
405
|
* periodically verifies the authentication status and triggers re-authentication
|
|
377
|
-
* if needed.
|
|
378
|
-
* (
|
|
406
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour). The minimum
|
|
407
|
+
* depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes),
|
|
408
|
+
* Hobbyist: 3600 (1 hour).
|
|
379
409
|
*/
|
|
380
410
|
health_check_interval?: number;
|
|
381
411
|
/**
|
|
@@ -383,13 +413,19 @@ export interface ManagedAuthCreateRequest {
|
|
|
383
413
|
*/
|
|
384
414
|
login_url?: string;
|
|
385
415
|
/**
|
|
386
|
-
*
|
|
416
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
417
|
+
* caller's org.
|
|
387
418
|
*/
|
|
388
419
|
proxy?: ManagedAuthCreateRequest.Proxy;
|
|
420
|
+
/**
|
|
421
|
+
* Whether to save credentials after every successful login. Defaults to true.
|
|
422
|
+
* One-time codes (TOTP, SMS, etc.) are not saved.
|
|
423
|
+
*/
|
|
424
|
+
save_credentials?: boolean;
|
|
389
425
|
}
|
|
390
426
|
export declare namespace ManagedAuthCreateRequest {
|
|
391
427
|
/**
|
|
392
|
-
* Reference to credentials for
|
|
428
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
393
429
|
*
|
|
394
430
|
* - { name } for Kernel credentials
|
|
395
431
|
* - { provider, path } for external provider item
|
|
@@ -414,23 +450,29 @@ export declare namespace ManagedAuthCreateRequest {
|
|
|
414
450
|
provider?: string;
|
|
415
451
|
}
|
|
416
452
|
/**
|
|
417
|
-
*
|
|
453
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
454
|
+
* caller's org.
|
|
418
455
|
*/
|
|
419
456
|
interface Proxy {
|
|
420
457
|
/**
|
|
421
|
-
* ID
|
|
458
|
+
* Proxy ID
|
|
422
459
|
*/
|
|
423
|
-
|
|
460
|
+
id?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Proxy name
|
|
463
|
+
*/
|
|
464
|
+
name?: string;
|
|
424
465
|
}
|
|
425
466
|
}
|
|
426
467
|
/**
|
|
427
|
-
* Request to submit field values
|
|
468
|
+
* Request to submit field values, click an SSO button, or select an MFA method.
|
|
469
|
+
* Provide exactly one of fields, sso_button_selector, or mfa_option_id.
|
|
428
470
|
*/
|
|
429
471
|
export interface SubmitFieldsRequest {
|
|
430
472
|
/**
|
|
431
473
|
* Map of field name to value
|
|
432
474
|
*/
|
|
433
|
-
fields
|
|
475
|
+
fields?: {
|
|
434
476
|
[key: string]: string;
|
|
435
477
|
};
|
|
436
478
|
/**
|
|
@@ -479,7 +521,7 @@ export declare namespace ConnectionFollowResponse {
|
|
|
479
521
|
/**
|
|
480
522
|
* Fields awaiting input (present when flow_step=AWAITING_INPUT).
|
|
481
523
|
*/
|
|
482
|
-
discovered_fields?: Array<
|
|
524
|
+
discovered_fields?: Array<ManagedAuthStateEvent.DiscoveredField>;
|
|
483
525
|
/**
|
|
484
526
|
* Error message (present when flow_status=FAILED).
|
|
485
527
|
*/
|
|
@@ -521,6 +563,40 @@ export declare namespace ConnectionFollowResponse {
|
|
|
521
563
|
website_error?: string;
|
|
522
564
|
}
|
|
523
565
|
namespace ManagedAuthStateEvent {
|
|
566
|
+
/**
|
|
567
|
+
* A discovered form field
|
|
568
|
+
*/
|
|
569
|
+
interface DiscoveredField {
|
|
570
|
+
/**
|
|
571
|
+
* Field label
|
|
572
|
+
*/
|
|
573
|
+
label: string;
|
|
574
|
+
/**
|
|
575
|
+
* Field name
|
|
576
|
+
*/
|
|
577
|
+
name: string;
|
|
578
|
+
/**
|
|
579
|
+
* CSS selector for the field
|
|
580
|
+
*/
|
|
581
|
+
selector: string;
|
|
582
|
+
/**
|
|
583
|
+
* Field type
|
|
584
|
+
*/
|
|
585
|
+
type: 'text' | 'email' | 'password' | 'tel' | 'number' | 'url' | 'code' | 'totp';
|
|
586
|
+
/**
|
|
587
|
+
* If this field is associated with an MFA option, the type of that option (e.g.,
|
|
588
|
+
* password field linked to "Enter password" option)
|
|
589
|
+
*/
|
|
590
|
+
linked_mfa_type?: 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | null;
|
|
591
|
+
/**
|
|
592
|
+
* Field placeholder
|
|
593
|
+
*/
|
|
594
|
+
placeholder?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Whether field is required
|
|
597
|
+
*/
|
|
598
|
+
required?: boolean;
|
|
599
|
+
}
|
|
524
600
|
/**
|
|
525
601
|
* An MFA method option for verification
|
|
526
602
|
*/
|
|
@@ -591,7 +667,7 @@ export interface ConnectionCreateParams {
|
|
|
591
667
|
*/
|
|
592
668
|
allowed_domains?: Array<string>;
|
|
593
669
|
/**
|
|
594
|
-
* Reference to credentials for
|
|
670
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
595
671
|
*
|
|
596
672
|
* - { name } for Kernel credentials
|
|
597
673
|
* - { provider, path } for external provider item
|
|
@@ -601,8 +677,9 @@ export interface ConnectionCreateParams {
|
|
|
601
677
|
/**
|
|
602
678
|
* Interval in seconds between automatic health checks. When set, the system
|
|
603
679
|
* periodically verifies the authentication status and triggers re-authentication
|
|
604
|
-
* if needed.
|
|
605
|
-
* (
|
|
680
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour). The minimum
|
|
681
|
+
* depends on your plan: Enterprise: 300 (5 minutes), Startup: 1200 (20 minutes),
|
|
682
|
+
* Hobbyist: 3600 (1 hour).
|
|
606
683
|
*/
|
|
607
684
|
health_check_interval?: number;
|
|
608
685
|
/**
|
|
@@ -610,13 +687,19 @@ export interface ConnectionCreateParams {
|
|
|
610
687
|
*/
|
|
611
688
|
login_url?: string;
|
|
612
689
|
/**
|
|
613
|
-
*
|
|
690
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
691
|
+
* caller's org.
|
|
614
692
|
*/
|
|
615
693
|
proxy?: ConnectionCreateParams.Proxy;
|
|
694
|
+
/**
|
|
695
|
+
* Whether to save credentials after every successful login. Defaults to true.
|
|
696
|
+
* One-time codes (TOTP, SMS, etc.) are not saved.
|
|
697
|
+
*/
|
|
698
|
+
save_credentials?: boolean;
|
|
616
699
|
}
|
|
617
700
|
export declare namespace ConnectionCreateParams {
|
|
618
701
|
/**
|
|
619
|
-
* Reference to credentials for
|
|
702
|
+
* Reference to credentials for the auth connection. Use one of:
|
|
620
703
|
*
|
|
621
704
|
* - { name } for Kernel credentials
|
|
622
705
|
* - { provider, path } for external provider item
|
|
@@ -641,13 +724,18 @@ export declare namespace ConnectionCreateParams {
|
|
|
641
724
|
provider?: string;
|
|
642
725
|
}
|
|
643
726
|
/**
|
|
644
|
-
*
|
|
727
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
728
|
+
* caller's org.
|
|
645
729
|
*/
|
|
646
730
|
interface Proxy {
|
|
647
731
|
/**
|
|
648
|
-
* ID
|
|
732
|
+
* Proxy ID
|
|
733
|
+
*/
|
|
734
|
+
id?: string;
|
|
735
|
+
/**
|
|
736
|
+
* Proxy name
|
|
649
737
|
*/
|
|
650
|
-
|
|
738
|
+
name?: string;
|
|
651
739
|
}
|
|
652
740
|
}
|
|
653
741
|
export interface ConnectionListParams extends OffsetPaginationParams {
|
|
@@ -662,15 +750,32 @@ export interface ConnectionListParams extends OffsetPaginationParams {
|
|
|
662
750
|
}
|
|
663
751
|
export interface ConnectionLoginParams {
|
|
664
752
|
/**
|
|
665
|
-
*
|
|
753
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
754
|
+
* caller's org.
|
|
755
|
+
*/
|
|
756
|
+
proxy?: ConnectionLoginParams.Proxy;
|
|
757
|
+
}
|
|
758
|
+
export declare namespace ConnectionLoginParams {
|
|
759
|
+
/**
|
|
760
|
+
* Proxy selection. Provide either id or name. The proxy must belong to the
|
|
761
|
+
* caller's org.
|
|
666
762
|
*/
|
|
667
|
-
|
|
763
|
+
interface Proxy {
|
|
764
|
+
/**
|
|
765
|
+
* Proxy ID
|
|
766
|
+
*/
|
|
767
|
+
id?: string;
|
|
768
|
+
/**
|
|
769
|
+
* Proxy name
|
|
770
|
+
*/
|
|
771
|
+
name?: string;
|
|
772
|
+
}
|
|
668
773
|
}
|
|
669
774
|
export interface ConnectionSubmitParams {
|
|
670
775
|
/**
|
|
671
776
|
* Map of field name to value
|
|
672
777
|
*/
|
|
673
|
-
fields
|
|
778
|
+
fields?: {
|
|
674
779
|
[key: string]: string;
|
|
675
780
|
};
|
|
676
781
|
/**
|
|
@@ -683,6 +788,6 @@ export interface ConnectionSubmitParams {
|
|
|
683
788
|
sso_button_selector?: string;
|
|
684
789
|
}
|
|
685
790
|
export declare namespace Connections {
|
|
686
|
-
export { type
|
|
791
|
+
export { type LoginResponse as LoginResponse, type ManagedAuth as ManagedAuth, type ManagedAuthCreateRequest as ManagedAuthCreateRequest, type SubmitFieldsRequest as SubmitFieldsRequest, type SubmitFieldsResponse as SubmitFieldsResponse, type ConnectionFollowResponse as ConnectionFollowResponse, type ManagedAuthsOffsetPagination as ManagedAuthsOffsetPagination, type ConnectionCreateParams as ConnectionCreateParams, type ConnectionListParams as ConnectionListParams, type ConnectionLoginParams as ConnectionLoginParams, type ConnectionSubmitParams as ConnectionSubmitParams, };
|
|
687
792
|
}
|
|
688
793
|
//# sourceMappingURL=connections.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connections.d.ts","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,
|
|
1
|
+
{"version":3,"file":"connections.d.ts","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE;OAC9D,EAAE,MAAM,EAAE;OAEV,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,WAAW,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAQ1F;;;;;;;;;;;OAWG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,MAAM,4BAA4B,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,eAAe,GAAG,YAAY,CAAC;IAEvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;IAEnF;;OAEG;IACH,SAAS,CAAC,EACN,aAAa,GACb,gBAAgB,GAChB,0BAA0B,GAC1B,YAAY,GACZ,WAAW,GACX,IAAI,CAAC;IAET;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;;;;;OAMG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;QAEjF;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;QAEjF;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;QAE9D;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC;IAEjD;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,wBAAwB,CAAC,KAAK,CAAC;IAEvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;;OAMG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,wBAAwB,CAAC,qBAAqB,GAC9C,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,cAAc,CAAC;AAE1B,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,KAAK,EAAE,oBAAoB,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;QAE3E;;WAEG;QACH,SAAS,EAAE,aAAa,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,YAAY,GAAG,WAAW,CAAC;QAEtG;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;QAEjE;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;QAE/B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAErD;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;QAEpE;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;YAEjF;;;eAGG;YACH,eAAe,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;YAEjF;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;YAE9D;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAErC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;;OAMG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,KAAK,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC;CACrC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -8,8 +8,8 @@ const headers_1 = require("../../internal/headers.js");
|
|
|
8
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
9
9
|
class Connections extends resource_1.APIResource {
|
|
10
10
|
/**
|
|
11
|
-
* Creates
|
|
12
|
-
* Conflict if
|
|
11
|
+
* Creates an auth connection for a profile and domain combination. Returns 409
|
|
12
|
+
* Conflict if an auth connection already exists for the given profile and domain.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
@@ -23,8 +23,8 @@ class Connections extends resource_1.APIResource {
|
|
|
23
23
|
return this._client.post('/auth/connections', { body, ...options });
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* Retrieve
|
|
27
|
-
* progress.
|
|
26
|
+
* Retrieve an auth connection by its ID. Includes current flow state if a login is
|
|
27
|
+
* in progress.
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
30
|
* ```ts
|
|
@@ -37,7 +37,7 @@ class Connections extends resource_1.APIResource {
|
|
|
37
37
|
return this._client.get((0, path_1.path) `/auth/connections/${id}`, options);
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
|
-
* List
|
|
40
|
+
* List auth connections with optional filters for profile_name and domain.
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* ```ts
|
|
@@ -51,9 +51,9 @@ class Connections extends resource_1.APIResource {
|
|
|
51
51
|
return this._client.getAPIList('/auth/connections', (pagination_1.OffsetPagination), { query, ...options });
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
|
-
* Deletes
|
|
54
|
+
* Deletes an auth connection and terminates its workflow. This will:
|
|
55
55
|
*
|
|
56
|
-
* - Delete the
|
|
56
|
+
* - Delete the auth connection record
|
|
57
57
|
* - Terminate the Temporal workflow
|
|
58
58
|
* - Cancel any in-progress login flows
|
|
59
59
|
*
|
|
@@ -86,8 +86,8 @@ class Connections extends resource_1.APIResource {
|
|
|
86
86
|
});
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
* Starts a login flow for the
|
|
90
|
-
* for the user to complete authentication, or triggers automatic re-auth if
|
|
89
|
+
* Starts a login flow for the auth connection. Returns immediately with a hosted
|
|
90
|
+
* URL for the user to complete authentication, or triggers automatic re-auth if
|
|
91
91
|
* credentials are stored.
|
|
92
92
|
*
|
|
93
93
|
* @example
|
|
@@ -101,18 +101,13 @@ class Connections extends resource_1.APIResource {
|
|
|
101
101
|
return this._client.post((0, path_1.path) `/auth/connections/${id}/login`, { body, ...options });
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Submits field values for the login form. Poll the
|
|
105
|
-
* and get results.
|
|
104
|
+
* Submits field values for the login form. Poll the auth connection to track
|
|
105
|
+
* progress and get results.
|
|
106
106
|
*
|
|
107
107
|
* @example
|
|
108
108
|
* ```ts
|
|
109
109
|
* const submitFieldsResponse =
|
|
110
|
-
* await client.auth.connections.submit('id'
|
|
111
|
-
* fields: {
|
|
112
|
-
* email: 'user@example.com',
|
|
113
|
-
* password: 'secret',
|
|
114
|
-
* },
|
|
115
|
-
* });
|
|
110
|
+
* await client.auth.connections.submit('id');
|
|
116
111
|
* ```
|
|
117
112
|
*/
|
|
118
113
|
submit(id, body, options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connections.js","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;
|
|
1
|
+
{"version":3,"file":"connections.js","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAmG;AAEnG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,6BAA6B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE;YACxD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,SAAS,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1E,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AA5HD,kCA4HC"}
|
|
@@ -5,8 +5,8 @@ import { buildHeaders } from "../../internal/headers.mjs";
|
|
|
5
5
|
import { path } from "../../internal/utils/path.mjs";
|
|
6
6
|
export class Connections extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Creates
|
|
9
|
-
* Conflict if
|
|
8
|
+
* Creates an auth connection for a profile and domain combination. Returns 409
|
|
9
|
+
* Conflict if an auth connection already exists for the given profile and domain.
|
|
10
10
|
*
|
|
11
11
|
* @example
|
|
12
12
|
* ```ts
|
|
@@ -20,8 +20,8 @@ export class Connections extends APIResource {
|
|
|
20
20
|
return this._client.post('/auth/connections', { body, ...options });
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve
|
|
24
|
-
* progress.
|
|
23
|
+
* Retrieve an auth connection by its ID. Includes current flow state if a login is
|
|
24
|
+
* in progress.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* ```ts
|
|
@@ -34,7 +34,7 @@ export class Connections extends APIResource {
|
|
|
34
34
|
return this._client.get(path `/auth/connections/${id}`, options);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* List
|
|
37
|
+
* List auth connections with optional filters for profile_name and domain.
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
40
|
* ```ts
|
|
@@ -48,9 +48,9 @@ export class Connections extends APIResource {
|
|
|
48
48
|
return this._client.getAPIList('/auth/connections', (OffsetPagination), { query, ...options });
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* Deletes
|
|
51
|
+
* Deletes an auth connection and terminates its workflow. This will:
|
|
52
52
|
*
|
|
53
|
-
* - Delete the
|
|
53
|
+
* - Delete the auth connection record
|
|
54
54
|
* - Terminate the Temporal workflow
|
|
55
55
|
* - Cancel any in-progress login flows
|
|
56
56
|
*
|
|
@@ -83,8 +83,8 @@ export class Connections extends APIResource {
|
|
|
83
83
|
});
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Starts a login flow for the
|
|
87
|
-
* for the user to complete authentication, or triggers automatic re-auth if
|
|
86
|
+
* Starts a login flow for the auth connection. Returns immediately with a hosted
|
|
87
|
+
* URL for the user to complete authentication, or triggers automatic re-auth if
|
|
88
88
|
* credentials are stored.
|
|
89
89
|
*
|
|
90
90
|
* @example
|
|
@@ -98,18 +98,13 @@ export class Connections extends APIResource {
|
|
|
98
98
|
return this._client.post(path `/auth/connections/${id}/login`, { body, ...options });
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
|
-
* Submits field values for the login form. Poll the
|
|
102
|
-
* and get results.
|
|
101
|
+
* Submits field values for the login form. Poll the auth connection to track
|
|
102
|
+
* progress and get results.
|
|
103
103
|
*
|
|
104
104
|
* @example
|
|
105
105
|
* ```ts
|
|
106
106
|
* const submitFieldsResponse =
|
|
107
|
-
* await client.auth.connections.submit('id'
|
|
108
|
-
* fields: {
|
|
109
|
-
* email: 'user@example.com',
|
|
110
|
-
* password: 'secret',
|
|
111
|
-
* },
|
|
112
|
-
* });
|
|
107
|
+
* await client.auth.connections.submit('id');
|
|
113
108
|
* ```
|
|
114
109
|
*/
|
|
115
110
|
submit(id, body, options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connections.mjs","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"connections.mjs","sourceRoot":"","sources":["../../src/resources/auth/connections.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gBAAgB,EAA4C;OAE9D,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,gBAA6B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACxD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,SAAS,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1E,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}
|