@onkernel/sdk 0.87.1 → 0.90.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 +25 -1
- package/client.d.mts +6 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -3
- package/client.d.ts.map +1 -1
- package/client.js +6 -1
- package/client.js.map +1 -1
- package/client.mjs +6 -1
- 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 +238 -88
- package/resources/auth/connections.d.mts.map +1 -1
- package/resources/auth/connections.d.ts +238 -88
- package/resources/auth/connections.d.ts.map +1 -1
- package/resources/auth/connections.js.map +1 -1
- 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/browser-pools.d.mts +46 -1
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +46 -1
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browsers/browsers.d.mts +194 -13
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +194 -13
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/index.d.mts +1 -1
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +1 -1
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invocations.d.mts +15 -1
- package/resources/invocations.d.mts.map +1 -1
- package/resources/invocations.d.ts +15 -1
- package/resources/invocations.d.ts.map +1 -1
- package/resources/organization/limits.d.mts +18 -3
- package/resources/organization/limits.d.mts.map +1 -1
- package/resources/organization/limits.d.ts +18 -3
- package/resources/organization/limits.d.ts.map +1 -1
- package/resources/organization/limits.js +1 -3
- package/resources/organization/limits.js.map +1 -1
- package/resources/organization/limits.mjs +1 -3
- package/resources/organization/limits.mjs.map +1 -1
- package/resources/projects/limits.d.mts +4 -4
- package/resources/projects/limits.d.mts.map +1 -1
- package/resources/projects/limits.d.ts +4 -4
- package/resources/projects/limits.d.ts.map +1 -1
- package/resources/projects/limits.js +6 -6
- package/resources/projects/limits.js.map +1 -1
- package/resources/projects/limits.mjs +6 -6
- package/resources/projects/limits.mjs.map +1 -1
- package/resources/projects/projects.d.mts +12 -10
- package/resources/projects/projects.d.mts.map +1 -1
- package/resources/projects/projects.d.ts +12 -10
- package/resources/projects/projects.d.ts.map +1 -1
- package/resources/projects/projects.js +11 -9
- package/resources/projects/projects.js.map +1 -1
- package/resources/projects/projects.mjs +11 -9
- package/resources/projects/projects.mjs.map +1 -1
- package/src/client.ts +17 -0
- package/src/resources/auth/auth.ts +2 -0
- package/src/resources/auth/connections.ts +286 -87
- package/src/resources/auth/index.ts +1 -0
- package/src/resources/browser-pools.ts +55 -1
- package/src/resources/browsers/browsers.ts +222 -12
- package/src/resources/browsers/index.ts +4 -0
- package/src/resources/index.ts +4 -0
- package/src/resources/invocations.ts +18 -1
- package/src/resources/organization/limits.ts +21 -3
- package/src/resources/projects/limits.ts +6 -6
- package/src/resources/projects/projects.ts +15 -13
- 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
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
2
|
import * as Shared from "../shared.js";
|
|
3
|
+
import * as BrowsersAPI from "../browsers/browsers.js";
|
|
3
4
|
import * as TelemetryAPI from "../browsers/telemetry.js";
|
|
4
5
|
import { APIPromise } from "../../core/api-promise.js";
|
|
5
6
|
import { OffsetPagination, type OffsetPaginationParams, PagePromise } from "../../core/pagination.js";
|
|
@@ -217,6 +218,11 @@ export interface ManagedAuth {
|
|
|
217
218
|
* check are marked as `NEEDS_AUTH` instead of attempting re-auth.
|
|
218
219
|
*/
|
|
219
220
|
auto_reauth?: boolean;
|
|
221
|
+
/**
|
|
222
|
+
* Default browser configuration for login, reauthentication, and health-check
|
|
223
|
+
* sessions.
|
|
224
|
+
*/
|
|
225
|
+
browser?: ManagedAuthBrowserConfig;
|
|
220
226
|
/**
|
|
221
227
|
* ID of the underlying browser session driving the current flow (present when flow
|
|
222
228
|
* in progress). Use this to inspect or terminate the browser session via the
|
|
@@ -224,9 +230,8 @@ export interface ManagedAuth {
|
|
|
224
230
|
*/
|
|
225
231
|
browser_session_id?: string | null;
|
|
226
232
|
/**
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
* overridden per-login.
|
|
233
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
234
|
+
* existing clients.
|
|
230
235
|
*/
|
|
231
236
|
browser_telemetry?: ManagedAuth.BrowserTelemetry | null;
|
|
232
237
|
/**
|
|
@@ -266,8 +271,10 @@ export interface ManagedAuth {
|
|
|
266
271
|
* automatically
|
|
267
272
|
* - `requires_email_code` — flow needs an email code that cannot be received
|
|
268
273
|
* automatically
|
|
274
|
+
* - `requires_customer_input` — flow needs another field or choice that is
|
|
275
|
+
* unavailable during unattended re-authentication
|
|
269
276
|
*/
|
|
270
|
-
can_reauth_reason?: 'external_credential' | 'cua_has_credential' | 'has_credential' | 'viable_plans_found' | 'no_requirements_recorded' | 'requirements_satisfiable' | 'no_prior_successful_login' | 'no_credential' | 'no_viable_plans' | 'viable_plans_require_external_action' | 'requires_external_action' | 'requires_totp_without_secret' | 'requires_sms_code' | 'requires_email_code';
|
|
277
|
+
can_reauth_reason?: 'external_credential' | 'cua_has_credential' | 'has_credential' | 'viable_plans_found' | 'no_requirements_recorded' | 'requirements_satisfiable' | 'no_prior_successful_login' | 'no_credential' | 'no_viable_plans' | 'viable_plans_require_external_action' | 'requires_external_action' | 'requires_totp_without_secret' | 'requires_sms_code' | 'requires_email_code' | 'requires_customer_input';
|
|
271
278
|
/**
|
|
272
279
|
* Canonical choices awaiting selection. Prefer this over pending_sso_buttons,
|
|
273
280
|
* mfa_options, and sign_in_options when present.
|
|
@@ -326,9 +333,10 @@ export interface ManagedAuth {
|
|
|
326
333
|
/**
|
|
327
334
|
* Interval in seconds between automatic health checks. When set, the system
|
|
328
335
|
* periodically verifies the authentication status and triggers re-authentication
|
|
329
|
-
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour)
|
|
330
|
-
* depends on your plan: Enterprise: 300
|
|
331
|
-
* Hobbyist: 3600 (1 hour)
|
|
336
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour) or your plan
|
|
337
|
+
* minimum, whichever is larger. The minimum depends on your plan: Enterprise: 300
|
|
338
|
+
* (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour), Free: 21600 (6
|
|
339
|
+
* hours).
|
|
332
340
|
*/
|
|
333
341
|
health_check_interval?: number | null;
|
|
334
342
|
/**
|
|
@@ -380,7 +388,8 @@ export interface ManagedAuth {
|
|
|
380
388
|
*/
|
|
381
389
|
post_login_url?: string;
|
|
382
390
|
/**
|
|
383
|
-
*
|
|
391
|
+
* @deprecated Deprecated. Read browser.proxy instead. Retained during migration
|
|
392
|
+
* for existing clients.
|
|
384
393
|
*/
|
|
385
394
|
proxy_id?: string;
|
|
386
395
|
/**
|
|
@@ -401,9 +410,8 @@ export interface ManagedAuth {
|
|
|
401
410
|
}
|
|
402
411
|
export declare namespace ManagedAuth {
|
|
403
412
|
/**
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
* overridden per-login.
|
|
413
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
414
|
+
* existing clients.
|
|
407
415
|
*/
|
|
408
416
|
interface BrowserTelemetry {
|
|
409
417
|
/**
|
|
@@ -497,10 +505,27 @@ export declare namespace ManagedAuth {
|
|
|
497
505
|
* Choice type.
|
|
498
506
|
*/
|
|
499
507
|
type: 'mfa_method' | 'sso_provider' | 'sign_in_method' | 'auth_method' | 'identifier_method' | 'account' | 'other';
|
|
508
|
+
/**
|
|
509
|
+
* Context captured for a choice.
|
|
510
|
+
*/
|
|
511
|
+
context?: string | null;
|
|
500
512
|
/**
|
|
501
513
|
* Additional context for the choice.
|
|
502
514
|
*/
|
|
503
515
|
description?: string | null;
|
|
516
|
+
/**
|
|
517
|
+
* Display text captured for a choice.
|
|
518
|
+
*/
|
|
519
|
+
display_text?: string | null;
|
|
520
|
+
/**
|
|
521
|
+
* Masked phone number or email address shown for an MFA choice.
|
|
522
|
+
*/
|
|
523
|
+
masked_destination?: string | null;
|
|
524
|
+
/**
|
|
525
|
+
* Semantic MFA method. Choice id remains the stable identity of the exact option
|
|
526
|
+
* selected.
|
|
527
|
+
*/
|
|
528
|
+
mfa_type?: 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | 'passkey' | 'switch' | 'other' | null;
|
|
504
529
|
/**
|
|
505
530
|
* Selector for the visible choice, when available.
|
|
506
531
|
*/
|
|
@@ -586,6 +611,10 @@ export declare namespace ManagedAuth {
|
|
|
586
611
|
* Managed-auth field type.
|
|
587
612
|
*/
|
|
588
613
|
type: 'identifier' | 'password' | 'code' | 'totp_code' | 'totp_secret' | 'text';
|
|
614
|
+
/**
|
|
615
|
+
* Context shown near the field, including a masked code destination.
|
|
616
|
+
*/
|
|
617
|
+
hint?: string;
|
|
589
618
|
/**
|
|
590
619
|
* Human-readable label shown to the user.
|
|
591
620
|
*/
|
|
@@ -663,6 +692,109 @@ export declare namespace ManagedAuth {
|
|
|
663
692
|
description?: string | null;
|
|
664
693
|
}
|
|
665
694
|
}
|
|
695
|
+
/**
|
|
696
|
+
* Browser configuration applied to browser sessions created for a managed auth
|
|
697
|
+
* connection. Managed auth controls the profile, headless mode, timeout, start
|
|
698
|
+
* URL, kiosk mode, and viewport.
|
|
699
|
+
*/
|
|
700
|
+
export interface ManagedAuthBrowserConfig {
|
|
701
|
+
/**
|
|
702
|
+
* Proxy configuration for managed auth browser sessions. Omit on create to derive
|
|
703
|
+
* the default from stealth, or on update and login to preserve or inherit the
|
|
704
|
+
* connection default.
|
|
705
|
+
*/
|
|
706
|
+
proxy?: BrowsersAPI.BrowserProxyConfig;
|
|
707
|
+
/**
|
|
708
|
+
* Whether managed auth browser sessions use stealth mode. Defaults to true when
|
|
709
|
+
* omitted.
|
|
710
|
+
*/
|
|
711
|
+
stealth?: boolean;
|
|
712
|
+
/**
|
|
713
|
+
* Browser telemetry configuration using the same semantics as browser create.
|
|
714
|
+
*/
|
|
715
|
+
telemetry?: ManagedAuthBrowserConfig.Telemetry | null;
|
|
716
|
+
}
|
|
717
|
+
export declare namespace ManagedAuthBrowserConfig {
|
|
718
|
+
/**
|
|
719
|
+
* Browser telemetry configuration using the same semantics as browser create.
|
|
720
|
+
*/
|
|
721
|
+
interface Telemetry {
|
|
722
|
+
/**
|
|
723
|
+
* Per-category capture flags. The operational categories (control, connection,
|
|
724
|
+
* system, captcha) are captured whenever telemetry is enabled; set one to
|
|
725
|
+
* enabled=false to opt out. The CDP categories (console, network, page,
|
|
726
|
+
* interaction) and screenshot are off by default; set enabled=true to opt in. On
|
|
727
|
+
* create, provided categories layer onto the default set. On update, provided
|
|
728
|
+
* categories merge onto the session's current config; when no telemetry is active
|
|
729
|
+
* this falls back to the default set (matching create). If browser is omitted or
|
|
730
|
+
* empty, the default set is used. A browser config that disables every category
|
|
731
|
+
* stops capture on update and starts no capture on create.
|
|
732
|
+
*/
|
|
733
|
+
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
|
|
734
|
+
/**
|
|
735
|
+
* Request shortcut for browser telemetry capture. True enables capture; with no
|
|
736
|
+
* browser category settings it captures the default set (control, connection,
|
|
737
|
+
* system, captcha), and any browser category settings are layered onto that
|
|
738
|
+
* default set. On update, enabled=true resolves the config fresh from the default
|
|
739
|
+
* set plus any provided categories, replacing the session's current selection
|
|
740
|
+
* rather than merging onto it; omit enabled to merge categories onto the current
|
|
741
|
+
* selection instead. False stops capture on update and starts no capture on
|
|
742
|
+
* create. enabled=false cannot be combined with browser category settings.
|
|
743
|
+
*/
|
|
744
|
+
enabled?: boolean;
|
|
745
|
+
/**
|
|
746
|
+
* Where to export this session's captured telemetry. Omit to capture without
|
|
747
|
+
* exporting.
|
|
748
|
+
*/
|
|
749
|
+
export?: Telemetry.Export;
|
|
750
|
+
}
|
|
751
|
+
namespace Telemetry {
|
|
752
|
+
/**
|
|
753
|
+
* Where to export this session's captured telemetry. Omit to capture without
|
|
754
|
+
* exporting.
|
|
755
|
+
*/
|
|
756
|
+
interface Export {
|
|
757
|
+
/**
|
|
758
|
+
* Export captured telemetry over OTLP to one of the org's configured destinations.
|
|
759
|
+
*/
|
|
760
|
+
otlp?: Export.Otlp;
|
|
761
|
+
}
|
|
762
|
+
namespace Export {
|
|
763
|
+
/**
|
|
764
|
+
* Export captured telemetry over OTLP to one of the org's configured destinations.
|
|
765
|
+
*/
|
|
766
|
+
interface Otlp {
|
|
767
|
+
/**
|
|
768
|
+
* OTLP destination to export this session's captured telemetry to. Provide either
|
|
769
|
+
* id or name. Requires telemetry capture to be enabled.
|
|
770
|
+
*/
|
|
771
|
+
destination?: Otlp.Destination;
|
|
772
|
+
/**
|
|
773
|
+
* Whether to export captured telemetry over OTLP. Setting destination implies
|
|
774
|
+
* enabled=true, so this only needs to be set explicitly to disable export
|
|
775
|
+
* (enabled=false with a destination is rejected).
|
|
776
|
+
*/
|
|
777
|
+
enabled?: boolean;
|
|
778
|
+
}
|
|
779
|
+
namespace Otlp {
|
|
780
|
+
/**
|
|
781
|
+
* OTLP destination to export this session's captured telemetry to. Provide either
|
|
782
|
+
* id or name. Requires telemetry capture to be enabled.
|
|
783
|
+
*/
|
|
784
|
+
interface Destination {
|
|
785
|
+
/**
|
|
786
|
+
* OTLP destination ID
|
|
787
|
+
*/
|
|
788
|
+
id?: string;
|
|
789
|
+
/**
|
|
790
|
+
* OTLP destination name
|
|
791
|
+
*/
|
|
792
|
+
name?: string;
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
}
|
|
666
798
|
/**
|
|
667
799
|
* Request to create an auth connection for a profile and domain
|
|
668
800
|
*/
|
|
@@ -708,9 +840,13 @@ export interface ManagedAuthCreateRequest {
|
|
|
708
840
|
*/
|
|
709
841
|
auto_reauth?: boolean;
|
|
710
842
|
/**
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
|
|
843
|
+
* Default browser configuration for login, reauthentication, and health-check
|
|
844
|
+
* sessions.
|
|
845
|
+
*/
|
|
846
|
+
browser?: ManagedAuthBrowserConfig;
|
|
847
|
+
/**
|
|
848
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
849
|
+
* existing clients.
|
|
714
850
|
*/
|
|
715
851
|
browser_telemetry?: ManagedAuthCreateRequest.BrowserTelemetry | null;
|
|
716
852
|
/**
|
|
@@ -724,9 +860,10 @@ export interface ManagedAuthCreateRequest {
|
|
|
724
860
|
/**
|
|
725
861
|
* Interval in seconds between automatic health checks. When set, the system
|
|
726
862
|
* periodically verifies the authentication status and triggers re-authentication
|
|
727
|
-
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour)
|
|
728
|
-
* depends on your plan: Enterprise: 300
|
|
729
|
-
* Hobbyist: 3600 (1 hour)
|
|
863
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour) or your plan
|
|
864
|
+
* minimum, whichever is larger. The minimum depends on your plan: Enterprise: 300
|
|
865
|
+
* (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour), Free: 21600 (6
|
|
866
|
+
* hours).
|
|
730
867
|
*/
|
|
731
868
|
health_check_interval?: number;
|
|
732
869
|
/**
|
|
@@ -741,10 +878,8 @@ export interface ManagedAuthCreateRequest {
|
|
|
741
878
|
*/
|
|
742
879
|
login_url?: string;
|
|
743
880
|
/**
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
747
|
-
* id for stable references.
|
|
881
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
882
|
+
* existing clients.
|
|
748
883
|
*/
|
|
749
884
|
proxy?: ManagedAuthCreateRequest.Proxy;
|
|
750
885
|
/**
|
|
@@ -760,9 +895,8 @@ export interface ManagedAuthCreateRequest {
|
|
|
760
895
|
}
|
|
761
896
|
export declare namespace ManagedAuthCreateRequest {
|
|
762
897
|
/**
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
* per-login.
|
|
898
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
899
|
+
* existing clients.
|
|
766
900
|
*/
|
|
767
901
|
interface BrowserTelemetry {
|
|
768
902
|
/**
|
|
@@ -866,10 +1000,8 @@ export declare namespace ManagedAuthCreateRequest {
|
|
|
866
1000
|
provider?: string;
|
|
867
1001
|
}
|
|
868
1002
|
/**
|
|
869
|
-
*
|
|
870
|
-
*
|
|
871
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
872
|
-
* id for stable references.
|
|
1003
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1004
|
+
* existing clients.
|
|
873
1005
|
*/
|
|
874
1006
|
interface Proxy {
|
|
875
1007
|
/**
|
|
@@ -965,9 +1097,13 @@ export interface ManagedAuthUpdateRequest {
|
|
|
965
1097
|
*/
|
|
966
1098
|
auto_reauth?: boolean;
|
|
967
1099
|
/**
|
|
968
|
-
* Browser
|
|
969
|
-
*
|
|
970
|
-
|
|
1100
|
+
* Browser configuration updates for future login, reauthentication, and
|
|
1101
|
+
* health-check sessions. Omitted properties remain unchanged.
|
|
1102
|
+
*/
|
|
1103
|
+
browser?: ManagedAuthBrowserConfig;
|
|
1104
|
+
/**
|
|
1105
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1106
|
+
* existing clients.
|
|
971
1107
|
*/
|
|
972
1108
|
browser_telemetry?: ManagedAuthUpdateRequest.BrowserTelemetry | null;
|
|
973
1109
|
/**
|
|
@@ -994,10 +1130,8 @@ export interface ManagedAuthUpdateRequest {
|
|
|
994
1130
|
*/
|
|
995
1131
|
login_url?: string;
|
|
996
1132
|
/**
|
|
997
|
-
*
|
|
998
|
-
*
|
|
999
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1000
|
-
* id for stable references.
|
|
1133
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1134
|
+
* existing clients.
|
|
1001
1135
|
*/
|
|
1002
1136
|
proxy?: ManagedAuthUpdateRequest.Proxy;
|
|
1003
1137
|
/**
|
|
@@ -1011,9 +1145,8 @@ export interface ManagedAuthUpdateRequest {
|
|
|
1011
1145
|
}
|
|
1012
1146
|
export declare namespace ManagedAuthUpdateRequest {
|
|
1013
1147
|
/**
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
1016
|
-
* disable telemetry.
|
|
1148
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1149
|
+
* existing clients.
|
|
1017
1150
|
*/
|
|
1018
1151
|
interface BrowserTelemetry {
|
|
1019
1152
|
/**
|
|
@@ -1117,10 +1250,8 @@ export declare namespace ManagedAuthUpdateRequest {
|
|
|
1117
1250
|
provider?: string;
|
|
1118
1251
|
}
|
|
1119
1252
|
/**
|
|
1120
|
-
*
|
|
1121
|
-
*
|
|
1122
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1123
|
-
* id for stable references.
|
|
1253
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1254
|
+
* existing clients.
|
|
1124
1255
|
*/
|
|
1125
1256
|
interface Proxy {
|
|
1126
1257
|
/**
|
|
@@ -1293,10 +1424,27 @@ export declare namespace ConnectionFollowResponse {
|
|
|
1293
1424
|
* Choice type.
|
|
1294
1425
|
*/
|
|
1295
1426
|
type: 'mfa_method' | 'sso_provider' | 'sign_in_method' | 'auth_method' | 'identifier_method' | 'account' | 'other';
|
|
1427
|
+
/**
|
|
1428
|
+
* Context captured for a choice.
|
|
1429
|
+
*/
|
|
1430
|
+
context?: string | null;
|
|
1296
1431
|
/**
|
|
1297
1432
|
* Additional context for the choice.
|
|
1298
1433
|
*/
|
|
1299
1434
|
description?: string | null;
|
|
1435
|
+
/**
|
|
1436
|
+
* Display text captured for a choice.
|
|
1437
|
+
*/
|
|
1438
|
+
display_text?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Masked phone number or email address shown for an MFA choice.
|
|
1441
|
+
*/
|
|
1442
|
+
masked_destination?: string | null;
|
|
1443
|
+
/**
|
|
1444
|
+
* Semantic MFA method. Choice id remains the stable identity of the exact option
|
|
1445
|
+
* selected.
|
|
1446
|
+
*/
|
|
1447
|
+
mfa_type?: 'sms' | 'call' | 'email' | 'totp' | 'push' | 'password' | 'passkey' | 'switch' | 'other' | null;
|
|
1300
1448
|
/**
|
|
1301
1449
|
* Selector for the visible choice, when available.
|
|
1302
1450
|
*/
|
|
@@ -1357,6 +1505,10 @@ export declare namespace ConnectionFollowResponse {
|
|
|
1357
1505
|
* Managed-auth field type.
|
|
1358
1506
|
*/
|
|
1359
1507
|
type: 'identifier' | 'password' | 'code' | 'totp_code' | 'totp_secret' | 'text';
|
|
1508
|
+
/**
|
|
1509
|
+
* Context shown near the field, including a masked code destination.
|
|
1510
|
+
*/
|
|
1511
|
+
hint?: string;
|
|
1360
1512
|
/**
|
|
1361
1513
|
* Human-readable label shown to the user.
|
|
1362
1514
|
*/
|
|
@@ -1477,9 +1629,13 @@ export interface ConnectionCreateParams {
|
|
|
1477
1629
|
*/
|
|
1478
1630
|
auto_reauth?: boolean;
|
|
1479
1631
|
/**
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1482
|
-
|
|
1632
|
+
* Default browser configuration for login, reauthentication, and health-check
|
|
1633
|
+
* sessions.
|
|
1634
|
+
*/
|
|
1635
|
+
browser?: ManagedAuthBrowserConfig;
|
|
1636
|
+
/**
|
|
1637
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1638
|
+
* existing clients.
|
|
1483
1639
|
*/
|
|
1484
1640
|
browser_telemetry?: ConnectionCreateParams.BrowserTelemetry | null;
|
|
1485
1641
|
/**
|
|
@@ -1493,9 +1649,10 @@ export interface ConnectionCreateParams {
|
|
|
1493
1649
|
/**
|
|
1494
1650
|
* Interval in seconds between automatic health checks. When set, the system
|
|
1495
1651
|
* periodically verifies the authentication status and triggers re-authentication
|
|
1496
|
-
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour)
|
|
1497
|
-
* depends on your plan: Enterprise: 300
|
|
1498
|
-
* Hobbyist: 3600 (1 hour)
|
|
1652
|
+
* if needed. Maximum is 86400 (24 hours). Default is 3600 (1 hour) or your plan
|
|
1653
|
+
* minimum, whichever is larger. The minimum depends on your plan: Enterprise: 300
|
|
1654
|
+
* (5 minutes), Startup: 1200 (20 minutes), Hobbyist: 3600 (1 hour), Free: 21600 (6
|
|
1655
|
+
* hours).
|
|
1499
1656
|
*/
|
|
1500
1657
|
health_check_interval?: number;
|
|
1501
1658
|
/**
|
|
@@ -1510,10 +1667,8 @@ export interface ConnectionCreateParams {
|
|
|
1510
1667
|
*/
|
|
1511
1668
|
login_url?: string;
|
|
1512
1669
|
/**
|
|
1513
|
-
*
|
|
1514
|
-
*
|
|
1515
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1516
|
-
* id for stable references.
|
|
1670
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1671
|
+
* existing clients.
|
|
1517
1672
|
*/
|
|
1518
1673
|
proxy?: ConnectionCreateParams.Proxy;
|
|
1519
1674
|
/**
|
|
@@ -1529,9 +1684,8 @@ export interface ConnectionCreateParams {
|
|
|
1529
1684
|
}
|
|
1530
1685
|
export declare namespace ConnectionCreateParams {
|
|
1531
1686
|
/**
|
|
1532
|
-
*
|
|
1533
|
-
*
|
|
1534
|
-
* per-login.
|
|
1687
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1688
|
+
* existing clients.
|
|
1535
1689
|
*/
|
|
1536
1690
|
interface BrowserTelemetry {
|
|
1537
1691
|
/**
|
|
@@ -1635,10 +1789,8 @@ export declare namespace ConnectionCreateParams {
|
|
|
1635
1789
|
provider?: string;
|
|
1636
1790
|
}
|
|
1637
1791
|
/**
|
|
1638
|
-
*
|
|
1639
|
-
*
|
|
1640
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1641
|
-
* id for stable references.
|
|
1792
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1793
|
+
* existing clients.
|
|
1642
1794
|
*/
|
|
1643
1795
|
interface Proxy {
|
|
1644
1796
|
/**
|
|
@@ -1667,9 +1819,13 @@ export interface ConnectionUpdateParams {
|
|
|
1667
1819
|
*/
|
|
1668
1820
|
auto_reauth?: boolean;
|
|
1669
1821
|
/**
|
|
1670
|
-
* Browser
|
|
1671
|
-
*
|
|
1672
|
-
|
|
1822
|
+
* Browser configuration updates for future login, reauthentication, and
|
|
1823
|
+
* health-check sessions. Omitted properties remain unchanged.
|
|
1824
|
+
*/
|
|
1825
|
+
browser?: ManagedAuthBrowserConfig;
|
|
1826
|
+
/**
|
|
1827
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1828
|
+
* existing clients.
|
|
1673
1829
|
*/
|
|
1674
1830
|
browser_telemetry?: ConnectionUpdateParams.BrowserTelemetry | null;
|
|
1675
1831
|
/**
|
|
@@ -1696,10 +1852,8 @@ export interface ConnectionUpdateParams {
|
|
|
1696
1852
|
*/
|
|
1697
1853
|
login_url?: string;
|
|
1698
1854
|
/**
|
|
1699
|
-
*
|
|
1700
|
-
*
|
|
1701
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1702
|
-
* id for stable references.
|
|
1855
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1856
|
+
* existing clients.
|
|
1703
1857
|
*/
|
|
1704
1858
|
proxy?: ConnectionUpdateParams.Proxy;
|
|
1705
1859
|
/**
|
|
@@ -1713,9 +1867,8 @@ export interface ConnectionUpdateParams {
|
|
|
1713
1867
|
}
|
|
1714
1868
|
export declare namespace ConnectionUpdateParams {
|
|
1715
1869
|
/**
|
|
1716
|
-
*
|
|
1717
|
-
*
|
|
1718
|
-
* disable telemetry.
|
|
1870
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
1871
|
+
* existing clients.
|
|
1719
1872
|
*/
|
|
1720
1873
|
interface BrowserTelemetry {
|
|
1721
1874
|
/**
|
|
@@ -1819,10 +1972,8 @@ export declare namespace ConnectionUpdateParams {
|
|
|
1819
1972
|
provider?: string;
|
|
1820
1973
|
}
|
|
1821
1974
|
/**
|
|
1822
|
-
*
|
|
1823
|
-
*
|
|
1824
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1825
|
-
* id for stable references.
|
|
1975
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
1976
|
+
* existing clients.
|
|
1826
1977
|
*/
|
|
1827
1978
|
interface Proxy {
|
|
1828
1979
|
/**
|
|
@@ -1851,16 +2002,18 @@ export interface ConnectionListParams extends OffsetPaginationParams {
|
|
|
1851
2002
|
}
|
|
1852
2003
|
export interface ConnectionLoginParams {
|
|
1853
2004
|
/**
|
|
1854
|
-
*
|
|
1855
|
-
*
|
|
1856
|
-
|
|
2005
|
+
* Browser configuration override for this login. Omitted properties inherit the
|
|
2006
|
+
* connection defaults.
|
|
2007
|
+
*/
|
|
2008
|
+
browser?: ManagedAuthBrowserConfig;
|
|
2009
|
+
/**
|
|
2010
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
2011
|
+
* existing clients.
|
|
1857
2012
|
*/
|
|
1858
2013
|
browser_telemetry?: ConnectionLoginParams.BrowserTelemetry | null;
|
|
1859
2014
|
/**
|
|
1860
|
-
*
|
|
1861
|
-
*
|
|
1862
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1863
|
-
* id for stable references.
|
|
2015
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
2016
|
+
* existing clients.
|
|
1864
2017
|
*/
|
|
1865
2018
|
proxy?: ConnectionLoginParams.Proxy;
|
|
1866
2019
|
/**
|
|
@@ -1871,9 +2024,8 @@ export interface ConnectionLoginParams {
|
|
|
1871
2024
|
}
|
|
1872
2025
|
export declare namespace ConnectionLoginParams {
|
|
1873
2026
|
/**
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
* the exact create-browser configuration.
|
|
2027
|
+
* @deprecated Deprecated. Use browser.telemetry. Retained during migration for
|
|
2028
|
+
* existing clients.
|
|
1877
2029
|
*/
|
|
1878
2030
|
interface BrowserTelemetry {
|
|
1879
2031
|
/**
|
|
@@ -1952,10 +2104,8 @@ export declare namespace ConnectionLoginParams {
|
|
|
1952
2104
|
}
|
|
1953
2105
|
}
|
|
1954
2106
|
/**
|
|
1955
|
-
*
|
|
1956
|
-
*
|
|
1957
|
-
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1958
|
-
* id for stable references.
|
|
2107
|
+
* @deprecated Deprecated. Use browser.proxy. Retained during migration for
|
|
2108
|
+
* existing clients.
|
|
1959
2109
|
*/
|
|
1960
2110
|
interface Proxy {
|
|
1961
2111
|
/**
|
|
@@ -2011,6 +2161,6 @@ export interface ConnectionTimelineParams extends OffsetPaginationParams {
|
|
|
2011
2161
|
type?: 'login' | 'reauth' | 'health_check';
|
|
2012
2162
|
}
|
|
2013
2163
|
export declare namespace Connections {
|
|
2014
|
-
export { type LoginResponse as LoginResponse, type ManagedAuth as ManagedAuth, type ManagedAuthCreateRequest as ManagedAuthCreateRequest, type ManagedAuthTimelineEvent as ManagedAuthTimelineEvent, type ManagedAuthUpdateRequest as ManagedAuthUpdateRequest, type SubmitFieldsRequest as SubmitFieldsRequest, type SubmitFieldsResponse as SubmitFieldsResponse, type ConnectionFollowResponse as ConnectionFollowResponse, type ManagedAuthsOffsetPagination as ManagedAuthsOffsetPagination, type ManagedAuthTimelineEventsOffsetPagination as ManagedAuthTimelineEventsOffsetPagination, type ConnectionCreateParams as ConnectionCreateParams, type ConnectionUpdateParams as ConnectionUpdateParams, type ConnectionListParams as ConnectionListParams, type ConnectionLoginParams as ConnectionLoginParams, type ConnectionSubmitParams as ConnectionSubmitParams, type ConnectionTimelineParams as ConnectionTimelineParams, };
|
|
2164
|
+
export { type LoginResponse as LoginResponse, type ManagedAuth as ManagedAuth, type ManagedAuthBrowserConfig as ManagedAuthBrowserConfig, type ManagedAuthCreateRequest as ManagedAuthCreateRequest, type ManagedAuthTimelineEvent as ManagedAuthTimelineEvent, type ManagedAuthUpdateRequest as ManagedAuthUpdateRequest, type SubmitFieldsRequest as SubmitFieldsRequest, type SubmitFieldsResponse as SubmitFieldsResponse, type ConnectionFollowResponse as ConnectionFollowResponse, type ManagedAuthsOffsetPagination as ManagedAuthsOffsetPagination, type ManagedAuthTimelineEventsOffsetPagination as ManagedAuthTimelineEventsOffsetPagination, type ConnectionCreateParams as ConnectionCreateParams, type ConnectionUpdateParams as ConnectionUpdateParams, type ConnectionListParams as ConnectionListParams, type ConnectionLoginParams as ConnectionLoginParams, type ConnectionSubmitParams as ConnectionSubmitParams, type ConnectionTimelineParams as ConnectionTimelineParams, };
|
|
2015
2165
|
}
|
|
2016
2166
|
//# sourceMappingURL=connections.d.ts.map
|