Repository navigation
Expand file tree
/
Copy pathtypesGenerated.ts
More file actions
3317 lines (2873 loc) · 83.3 KB
/
Copy pathtypesGenerated.ts
File metadata and controls
3317 lines (2873 loc) · 83.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by 'guts'. DO NOT EDIT.
// From codersdk/templates.go
export interface ACLAvailable {
readonly users: readonly ReducedUser[];
readonly groups: readonly Group[];
}
// From codersdk/apikey.go
export interface APIKey {
readonly id: string;
readonly user_id: string;
readonly last_used: string;
readonly expires_at: string;
readonly created_at: string;
readonly updated_at: string;
readonly login_type: LoginType;
readonly scope: APIKeyScope;
readonly token_name: string;
readonly lifetime_seconds: number;
}
// From codersdk/apikey.go
export type APIKeyScope = "all" | "application_connect";
export const APIKeyScopes: APIKeyScope[] = ["all", "application_connect"];
// From codersdk/apikey.go
export interface APIKeyWithOwner extends APIKey {
readonly username: string;
}
// From healthsdk/healthsdk.go
export interface AccessURLReport extends BaseReport {
readonly healthy: boolean;
readonly access_url: string;
readonly reachable: boolean;
readonly status_code: number;
readonly healthz_response: string;
}
// From codersdk/licenses.go
export interface AddLicenseRequest {
readonly license: string;
}
// From codersdk/workspacebuilds.go
export interface AgentConnectionTiming {
readonly started_at: string;
readonly ended_at: string;
readonly stage: TimingStage;
readonly workspace_agent_id: string;
readonly workspace_agent_name: string;
}
// From codersdk/workspacebuilds.go
export interface AgentScriptTiming {
readonly started_at: string;
readonly ended_at: string;
readonly exit_code: number;
readonly stage: TimingStage;
readonly status: string;
readonly display_name: string;
readonly workspace_agent_id: string;
readonly workspace_agent_name: string;
}
// From codersdk/templates.go
export interface AgentStatsReportResponse {
readonly num_comms: number;
readonly rx_bytes: number;
readonly tx_bytes: number;
}
// From codersdk/workspaceagents.go
export type AgentSubsystem = "envbox" | "envbuilder" | "exectrace";
export const AgentSubsystems: AgentSubsystem[] = [
"envbox",
"envbuilder",
"exectrace",
];
// From codersdk/deployment.go
export interface AppHostResponse {
readonly host: string;
}
// From codersdk/deployment.go
export interface AppearanceConfig {
readonly application_name: string;
readonly logo_url: string;
readonly docs_url: string;
readonly service_banner: BannerConfig;
readonly announcement_banners: readonly BannerConfig[];
readonly support_links?: readonly LinkConfig[];
}
// From codersdk/templates.go
export interface ArchiveTemplateVersionsRequest {
readonly all: boolean;
}
// From codersdk/templates.go
export interface ArchiveTemplateVersionsResponse {
readonly template_id: string;
readonly archived_ids: readonly string[];
}
// From codersdk/roles.go
export interface AssignableRoles extends Role {
readonly assignable: boolean;
readonly built_in: boolean;
}
// From codersdk/audit.go
export type AuditAction =
| "create"
| "delete"
| "login"
| "logout"
| "register"
| "request_password_reset"
| "start"
| "stop"
| "write";
export const AuditActions: AuditAction[] = [
"create",
"delete",
"login",
"logout",
"register",
"request_password_reset",
"start",
"stop",
"write",
];
// From codersdk/audit.go
export type AuditDiff = Record<string, AuditDiffField>;
// From codersdk/audit.go
export interface AuditDiffField {
// empty interface{} type, falling back to unknown
readonly old?: unknown;
// empty interface{} type, falling back to unknown
readonly new?: unknown;
readonly secret: boolean;
}
// From codersdk/audit.go
export interface AuditLog {
readonly id: string;
readonly request_id: string;
readonly time: string;
readonly ip: string;
readonly user_agent: string;
readonly resource_type: ResourceType;
readonly resource_id: string;
readonly resource_target: string;
readonly resource_icon: string;
readonly action: AuditAction;
readonly diff: AuditDiff;
readonly status_code: number;
readonly additional_fields: Record<string, string>;
readonly description: string;
readonly resource_link: string;
readonly is_deleted: boolean;
readonly organization_id: string;
readonly organization?: MinimalOrganization;
readonly user: User | null;
}
// From codersdk/audit.go
export interface AuditLogResponse {
readonly audit_logs: readonly AuditLog[];
readonly count: number;
}
// From codersdk/audit.go
export interface AuditLogsRequest extends Pagination {
readonly q?: string;
}
// From codersdk/users.go
export interface AuthMethod {
readonly enabled: boolean;
}
// From codersdk/users.go
export interface AuthMethods {
readonly terms_of_service_url?: string;
readonly password: AuthMethod;
readonly github: AuthMethod;
readonly oidc: OIDCAuthMethod;
}
// From codersdk/authorization.go
export interface AuthorizationCheck {
readonly object: AuthorizationObject;
readonly action: RBACAction;
}
// From codersdk/authorization.go
export interface AuthorizationObject {
readonly resource_type: RBACResource;
readonly owner_id?: string;
readonly organization_id?: string;
readonly resource_id?: string;
readonly any_org?: boolean;
}
// From codersdk/authorization.go
export interface AuthorizationRequest {
readonly checks: Record<string, AuthorizationCheck>;
}
// From codersdk/authorization.go
export type AuthorizationResponse = Record<string, boolean>;
// From codersdk/workspaces.go
export type AutomaticUpdates = "always" | "never";
export const AutomaticUpdateses: AutomaticUpdates[] = ["always", "never"];
// From codersdk/deployment.go
export interface AvailableExperiments {
readonly safe: readonly Experiment[];
}
// From codersdk/deployment.go
export interface BannerConfig {
readonly enabled: boolean;
readonly message?: string;
readonly background_color?: string;
}
// From healthsdk/healthsdk.go
export interface BaseReport {
readonly error?: string;
readonly severity: HealthSeverity;
readonly warnings: readonly HealthMessage[];
readonly dismissed: boolean;
}
// From codersdk/deployment.go
export interface BuildInfoResponse {
readonly external_url: string;
readonly version: string;
readonly dashboard_url: string;
readonly telemetry: boolean;
readonly workspace_proxy: boolean;
readonly agent_api_version: string;
readonly provisioner_api_version: string;
readonly upgrade_message: string;
readonly deployment_id: string;
}
// From codersdk/workspacebuilds.go
export type BuildReason = "autostart" | "autostop" | "initiator";
export const BuildReasons: BuildReason[] = [
"autostart",
"autostop",
"initiator",
];
// From codersdk/client.go
export const BuildVersionHeader = "X-Coder-Build-Version";
// From codersdk/client.go
export const BypassRatelimitHeader = "X-Coder-Bypass-Ratelimit";
// From codersdk/client.go
export const CLITelemetryHeader = "Coder-CLI-Telemetry";
// From codersdk/users.go
export interface ChangePasswordWithOneTimePasscodeRequest {
readonly email: string;
readonly password: string;
readonly one_time_passcode: string;
}
// From codersdk/insights.go
export interface ConnectionLatency {
readonly p50: number;
readonly p95: number;
}
// From codersdk/files.go
export const ContentTypeTar = "application/x-tar";
// From codersdk/files.go
export const ContentTypeZip = "application/zip";
// From codersdk/users.go
export interface ConvertLoginRequest {
readonly to_type: LoginType;
readonly password: string;
}
// From codersdk/users.go
export interface CreateFirstUserRequest {
readonly email: string;
readonly username: string;
readonly name: string;
readonly password: string;
readonly trial: boolean;
readonly trial_info: CreateFirstUserTrialInfo;
}
// From codersdk/users.go
export interface CreateFirstUserResponse {
readonly user_id: string;
readonly organization_id: string;
}
// From codersdk/users.go
export interface CreateFirstUserTrialInfo {
readonly first_name: string;
readonly last_name: string;
readonly phone_number: string;
readonly job_title: string;
readonly company_name: string;
readonly country: string;
readonly developers: string;
}
// From codersdk/groups.go
export interface CreateGroupRequest {
readonly name: string;
readonly display_name: string;
readonly avatar_url: string;
readonly quota_allowance: number;
}
// From codersdk/organizations.go
export interface CreateOrganizationRequest {
readonly name: string;
readonly display_name?: string;
readonly description?: string;
readonly icon?: string;
}
// From codersdk/provisionerdaemons.go
export interface CreateProvisionerKeyRequest {
readonly name: string;
readonly tags: Record<string, string>;
}
// From codersdk/provisionerdaemons.go
export interface CreateProvisionerKeyResponse {
readonly key: string;
}
// From codersdk/organizations.go
export interface CreateTemplateRequest {
readonly name: string;
readonly display_name?: string;
readonly description?: string;
readonly icon?: string;
readonly template_version_id: string;
readonly default_ttl_ms?: number;
readonly activity_bump_ms?: number;
readonly autostop_requirement?: TemplateAutostopRequirement;
readonly autostart_requirement?: TemplateAutostartRequirement;
readonly allow_user_cancel_workspace_jobs: boolean | null;
readonly allow_user_autostart?: boolean;
readonly allow_user_autostop?: boolean;
readonly failure_ttl_ms?: number;
readonly dormant_ttl_ms?: number;
readonly delete_ttl_ms?: number;
readonly disable_everyone_group_access: boolean;
readonly require_active_version: boolean;
readonly max_port_share_level: WorkspaceAgentPortShareLevel | null;
}
// From codersdk/templateversions.go
export interface CreateTemplateVersionDryRunRequest {
readonly workspace_name: string;
readonly rich_parameter_values: readonly WorkspaceBuildParameter[];
readonly user_variable_values?: readonly VariableValue[];
}
// From codersdk/organizations.go
export interface CreateTemplateVersionRequest {
readonly name?: string;
readonly message?: string;
readonly template_id?: string;
readonly storage_method: ProvisionerStorageMethod;
readonly file_id?: string;
readonly example_id?: string;
readonly provisioner: ProvisionerType;
readonly tags: Record<string, string>;
readonly user_variable_values?: readonly VariableValue[];
}
// From codersdk/audit.go
export interface CreateTestAuditLogRequest {
readonly action?: AuditAction;
readonly resource_type?: ResourceType;
readonly resource_id?: string;
readonly additional_fields?: Record<string, string>;
readonly time?: string;
readonly build_reason?: BuildReason;
readonly organization_id?: string;
}
// From codersdk/apikey.go
export interface CreateTokenRequest {
readonly lifetime: number;
readonly scope: APIKeyScope;
readonly token_name: string;
}
// From codersdk/users.go
export interface CreateUserRequestWithOrgs {
readonly email: string;
readonly username: string;
readonly name: string;
readonly password: string;
readonly login_type: LoginType;
readonly user_status: UserStatus | null;
readonly organization_ids: readonly string[];
}
// From codersdk/workspaces.go
export interface CreateWorkspaceBuildRequest {
readonly template_version_id?: string;
readonly transition: WorkspaceTransition;
readonly dry_run?: boolean;
readonly state?: readonly string[];
readonly orphan?: boolean;
readonly rich_parameter_values?: readonly WorkspaceBuildParameter[];
readonly log_level?: ProvisionerLogLevel;
}
// From codersdk/workspaceproxy.go
export interface CreateWorkspaceProxyRequest {
readonly name: string;
readonly display_name: string;
readonly icon: string;
}
// From codersdk/organizations.go
export interface CreateWorkspaceRequest {
readonly template_id?: string;
readonly template_version_id?: string;
readonly name: string;
readonly autostart_schedule?: string;
readonly ttl_ms?: number;
readonly rich_parameter_values?: readonly WorkspaceBuildParameter[];
readonly automatic_updates?: AutomaticUpdates;
}
// From codersdk/deployment.go
export interface CryptoKey {
readonly feature: CryptoKeyFeature;
readonly secret: string;
readonly deletes_at: string;
readonly sequence: number;
readonly starts_at: string;
}
// From codersdk/deployment.go
export type CryptoKeyFeature =
| "oidc_convert"
| "tailnet_resume"
| "workspace_apps_api_key"
| "workspace_apps_token";
export const CryptoKeyFeatures: CryptoKeyFeature[] = [
"oidc_convert",
"tailnet_resume",
"workspace_apps_api_key",
"workspace_apps_token",
];
// From codersdk/roles.go
export interface CustomRoleRequest {
readonly name: string;
readonly display_name: string;
readonly site_permissions: readonly Permission[];
readonly organization_permissions: readonly Permission[];
readonly user_permissions: readonly Permission[];
}
// From codersdk/deployment.go
export interface DAUEntry {
readonly date: string;
readonly amount: number;
}
// From codersdk/deployment.go
export interface DAURequest {
readonly TZHourOffset: number;
}
// From codersdk/deployment.go
export interface DAUsResponse {
readonly entries: readonly DAUEntry[];
readonly tz_hour_offset: number;
}
// From codersdk/deployment.go
export interface DERP {
readonly server: DERPServerConfig;
readonly config: DERPConfig;
}
// From codersdk/deployment.go
export interface DERPConfig {
readonly block_direct: boolean;
readonly force_websockets: boolean;
readonly url: string;
readonly path: string;
}
// From healthsdk/healthsdk.go
export interface DERPHealthReport extends BaseReport {
readonly healthy: boolean;
readonly regions: Record<number, DERPRegionReport | null>;
readonly netcheck?: NetcheckReport;
readonly netcheck_err?: string;
readonly netcheck_logs: readonly string[];
}
// From healthsdk/healthsdk.go
export interface DERPNodeReport {
readonly healthy: boolean;
readonly severity: HealthSeverity;
readonly warnings: readonly HealthMessage[];
readonly error?: string;
readonly node: TailDERPNode | null;
readonly node_info: ServerInfoMessage;
readonly can_exchange_messages: boolean;
readonly round_trip_ping: string;
readonly round_trip_ping_ms: number;
readonly uses_websocket: boolean;
readonly client_logs: readonly string[][];
readonly client_errs: readonly string[][];
readonly stun: STUNReport;
}
// From codersdk/workspaceagents.go
export interface DERPRegion {
readonly preferred: boolean;
readonly latency_ms: number;
}
// From healthsdk/healthsdk.go
export interface DERPRegionReport {
readonly healthy: boolean;
readonly severity: HealthSeverity;
readonly warnings: readonly HealthMessage[];
readonly error?: string;
readonly region: TailDERPRegion | null;
readonly node_reports: readonly (DERPNodeReport | null)[];
}
// From codersdk/deployment.go
export interface DERPServerConfig {
readonly enable: boolean;
readonly region_id: number;
readonly region_code: string;
readonly region_name: string;
readonly stun_addresses: string;
readonly relay_url: string;
}
// From codersdk/deployment.go
export interface DangerousConfig {
readonly allow_path_app_sharing: boolean;
readonly allow_path_app_site_owner_access: boolean;
readonly allow_all_cors: boolean;
}
// From healthsdk/healthsdk.go
export interface DatabaseReport extends BaseReport {
readonly healthy: boolean;
readonly reachable: boolean;
readonly latency: string;
readonly latency_ms: number;
readonly threshold_ms: number;
}
// From codersdk/workspaceagentportshare.go
export interface DeleteWorkspaceAgentPortShareRequest {
readonly agent_name: string;
readonly port: number;
}
// From codersdk/deployment.go
export interface DeploymentConfig {
readonly config?: DeploymentValues;
readonly options?: SerpentOptionSet;
}
// From codersdk/deployment.go
export interface DeploymentStats {
readonly aggregated_from: string;
readonly collected_at: string;
readonly next_update_at: string;
readonly workspaces: WorkspaceDeploymentStats;
readonly session_count: SessionCountDeploymentStats;
}
// From codersdk/deployment.go
export interface DeploymentValues {
readonly verbose?: boolean;
readonly access_url?: string;
readonly wildcard_access_url?: string;
readonly docs_url?: string;
readonly redirect_to_access_url?: boolean;
readonly http_address?: string;
readonly autobuild_poll_interval?: number;
readonly job_hang_detector_interval?: number;
readonly derp?: DERP;
readonly prometheus?: PrometheusConfig;
readonly pprof?: PprofConfig;
readonly proxy_trusted_headers?: string;
readonly proxy_trusted_origins?: string;
readonly cache_directory?: string;
readonly in_memory_database?: boolean;
readonly ephemeral_deployment?: boolean;
readonly pg_connection_url?: string;
readonly pg_auth?: string;
readonly oauth2?: OAuth2Config;
readonly oidc?: OIDCConfig;
readonly telemetry?: TelemetryConfig;
readonly tls?: TLSConfig;
readonly trace?: TraceConfig;
readonly secure_auth_cookie?: boolean;
readonly strict_transport_security?: number;
readonly strict_transport_security_options?: string;
readonly ssh_keygen_algorithm?: string;
readonly metrics_cache_refresh_interval?: number;
readonly agent_stat_refresh_interval?: number;
readonly agent_fallback_troubleshooting_url?: string;
readonly browser_only?: boolean;
readonly scim_api_key?: string;
readonly external_token_encryption_keys?: string;
readonly provisioner?: ProvisionerConfig;
readonly rate_limit?: RateLimitConfig;
readonly experiments?: string;
readonly update_check?: boolean;
readonly swagger?: SwaggerConfig;
readonly logging?: LoggingConfig;
readonly dangerous?: DangerousConfig;
readonly disable_path_apps?: boolean;
readonly session_lifetime?: SessionLifetime;
readonly disable_password_auth?: boolean;
readonly support?: SupportConfig;
readonly external_auth?: SerpentStruct<ExternalAuthConfig[]>;
readonly config_ssh?: SSHConfig;
readonly wgtunnel_host?: string;
readonly disable_owner_workspace_exec?: boolean;
readonly proxy_health_status_interval?: number;
readonly enable_terraform_debug_mode?: boolean;
readonly user_quiet_hours_schedule?: UserQuietHoursScheduleConfig;
readonly web_terminal_renderer?: string;
readonly allow_workspace_renames?: boolean;
readonly healthcheck?: HealthcheckConfig;
readonly cli_upgrade_message?: string;
readonly terms_of_service_url?: string;
readonly notifications?: NotificationsConfig;
readonly additional_csp_policy?: string;
readonly config?: string;
readonly write_config?: boolean;
readonly address?: string;
}
// From codersdk/workspaceagents.go
export type DisplayApp =
| "port_forwarding_helper"
| "ssh_helper"
| "vscode"
| "vscode_insiders"
| "web_terminal";
export const DisplayApps: DisplayApp[] = [
"port_forwarding_helper",
"ssh_helper",
"vscode",
"vscode_insiders",
"web_terminal",
];
// From codersdk/externalauth.go
export type EnhancedExternalAuthProvider =
| "azure-devops"
| "azure-devops-entra"
| "bitbucket-cloud"
| "bitbucket-server"
| "github"
| "gitlab"
| "gitea"
| "jfrog"
| "slack";
export const EnhancedExternalAuthProviders: EnhancedExternalAuthProvider[] = [
"azure-devops",
"azure-devops-entra",
"bitbucket-cloud",
"bitbucket-server",
"github",
"gitlab",
"gitea",
"jfrog",
"slack",
];
// From codersdk/deployment.go
export type Entitlement = "entitled" | "grace_period" | "not_entitled";
// From codersdk/deployment.go
export interface Entitlements {
readonly features: Record<FeatureName, Feature>;
readonly warnings: readonly string[];
readonly errors: readonly string[];
readonly has_license: boolean;
readonly trial: boolean;
readonly require_telemetry: boolean;
readonly refreshed_at: string;
}
// From codersdk/client.go
export const EntitlementsWarningHeader = "X-Coder-Entitlements-Warning";
// From codersdk/deployment.go
export type Experiment =
| "auto-fill-parameters"
| "example"
| "notifications"
| "workspace-usage";
// From codersdk/deployment.go
export type Experiments = readonly Experiment[];
// From codersdk/externalauth.go
export interface ExternalAuth {
readonly authenticated: boolean;
readonly device: boolean;
readonly display_name: string;
readonly user: ExternalAuthUser | null;
readonly app_installable: boolean;
readonly installations: readonly ExternalAuthAppInstallation[];
readonly app_install_url: string;
}
// From codersdk/externalauth.go
export interface ExternalAuthAppInstallation {
readonly id: number;
readonly account: ExternalAuthUser;
readonly configure_url: string;
}
// From codersdk/deployment.go
export interface ExternalAuthConfig {
readonly type: string;
readonly client_id: string;
readonly id: string;
readonly auth_url: string;
readonly token_url: string;
readonly validate_url: string;
readonly app_install_url: string;
readonly app_installations_url: string;
readonly no_refresh: boolean;
readonly scopes: readonly string[];
readonly device_flow: boolean;
readonly device_code_url: string;
readonly regex: string;
readonly display_name: string;
readonly display_icon: string;
}
// From codersdk/externalauth.go
export interface ExternalAuthDevice {
readonly device_code: string;
readonly user_code: string;
readonly verification_uri: string;
readonly expires_in: number;
readonly interval: number;
}
// From codersdk/externalauth.go
export interface ExternalAuthDeviceExchange {
readonly device_code: string;
}
// From codersdk/externalauth.go
export interface ExternalAuthLink {
readonly provider_id: string;
readonly created_at: string;
readonly updated_at: string;
readonly has_refresh_token: boolean;
readonly expires: string;
readonly authenticated: boolean;
readonly validate_error: string;
}
// From codersdk/externalauth.go
export interface ExternalAuthLinkProvider {
readonly id: string;
readonly type: string;
readonly device: boolean;
readonly display_name: string;
readonly display_icon: string;
readonly allow_refresh: boolean;
readonly allow_validate: boolean;
}
// From codersdk/externalauth.go
export interface ExternalAuthUser {
readonly id: number;
readonly login: string;
readonly avatar_url: string;
readonly profile_url: string;
readonly name: string;
}
// From codersdk/deployment.go
export interface Feature {
readonly entitlement: Entitlement;
readonly enabled: boolean;
readonly limit?: number;
readonly actual?: number;
}
// From codersdk/deployment.go
export type FeatureName =
| "access_control"
| "advanced_template_scheduling"
| "appearance"
| "audit_log"
| "browser_only"
| "control_shared_ports"
| "custom_roles"
| "external_provisioner_daemons"
| "external_token_encryption"
| "high_availability"
| "multiple_external_auth"
| "multiple_organizations"
| "scim"
| "template_rbac"
| "user_limit"
| "user_role_management"
| "workspace_batch_actions"
| "workspace_proxy";
export const FeatureNames: FeatureName[] = [
"access_control",
"advanced_template_scheduling",
"appearance",
"audit_log",
"browser_only",
"control_shared_ports",
"custom_roles",
"external_provisioner_daemons",
"external_token_encryption",
"high_availability",
"multiple_external_auth",
"multiple_organizations",
"scim",
"template_rbac",
"user_limit",
"user_role_management",
"workspace_batch_actions",
"workspace_proxy",
];
// From codersdk/deployment.go
export type FeatureSet = "enterprise" | "" | "premium";
export const FeatureSets: FeatureSet[] = ["enterprise", "", "premium"];
// From codersdk/files.go
export const FormatZip = "zip";
// From codersdk/apikey.go
export interface GenerateAPIKeyResponse {
readonly key: string;
}
// From codersdk/insights.go
export interface GetUserStatusCountsRequest {
readonly offset: string;
}
// From codersdk/insights.go
export interface GetUserStatusCountsResponse {
readonly status_counts: Record<UserStatus, UserStatusChangeCount[]>;
}
// From codersdk/users.go
export interface GetUsersResponse {
readonly users: readonly User[];
readonly count: number;
}
// From codersdk/gitsshkey.go
export interface GitSSHKey {
readonly user_id: string;
readonly created_at: string;
readonly updated_at: string;
readonly public_key: string;
}
// From codersdk/groups.go
export interface Group {
readonly id: string;
readonly name: string;
readonly display_name: string;
readonly organization_id: string;
readonly members: readonly ReducedUser[];
readonly total_member_count: number;
readonly avatar_url: string;
readonly quota_allowance: number;
readonly source: GroupSource;
readonly organization_name: string;
readonly organization_display_name: string;
}
// From codersdk/groups.go
export interface GroupArguments {
readonly Organization: string;
readonly HasMember: string;
readonly GroupIDs: readonly string[];
}
// From codersdk/groups.go
export type GroupSource = "oidc" | "user";
export const GroupSources: GroupSource[] = ["oidc", "user"];
// From codersdk/idpsync.go
export interface GroupSyncSettings {
readonly field: string;
readonly mapping: Record<string, string[]>;
readonly regex_filter: string | null;
readonly auto_create_missing_groups: boolean;
readonly legacy_group_name_mapping?: Record<string, string>;
}
// From health/model.go
export type HealthCode =
| "EACS03"
| "EACS02"
| "EACS04"
| "EACS01"
| "EDERP01"
| "EDERP02"
| "EDB01"
| "EDB02"
| "EPD03"
| "EPD02"
| "EPD01"
| "EWP02"
| "EWP04"
| "EWP01"
| "EUNKNOWN"
| "EWS01"
| "EWS02"
| "EWS03";
// From health/model.go
export const HealthCodeInterfaceSmallMTU = "EIF01";
// From health/model.go
export const HealthCodeSTUNMapVaryDest = "ESTUN02";
// From health/model.go
export const HealthCodeSTUNNoNodes = "ESTUN01";
export const HealthCodes: HealthCode[] = [
"EACS03",
"EACS02",
"EACS04",
"EACS01",
"EDERP01",
"EDERP02",
"EDB01",
"EDB02",
"EPD03",
"EPD02",
"EPD01",
"EWP02",
"EWP04",
"EWP01",
"EUNKNOWN",
"EWS01",
"EWS02",
"EWS03",
];
// From health/model.go
export interface HealthMessage {
readonly code: HealthCode;
readonly message: string;