Repository navigation
Expand file tree
/
Copy pathmodels.gen.go
More file actions
4347 lines (4343 loc) · 425 KB
/
Copy pathmodels.gen.go
File metadata and controls
4347 lines (4343 loc) · 425 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 sdk-generator/internal/sdkgen from openapi/spec.json; DO NOT EDIT.
// Spec sha256 731723cbd5b1bd7ca6f73cb98eabdd70b9fcd82d12a8231dbe1e6c3d4ae34475.
package sdk
import "github.com/kasmtech/go-sdk/internal/generated"
// The request, response and parameter types of the API, one per schema in the spec.
type (
// AccountingSummary One session accounting record.
AccountingSummary = generated.AccountingSummary
// ActiveDirectorySettings “active_directory_settings“ — populated when “ad_create_machine_record“
// is true; null otherwise.
ActiveDirectorySettings = generated.ActiveDirectorySettings
// ActiveDirectorySettingsCreate “active_directory_settings“ on create — required when
// “ad_create_machine_record“ is true; every field required within the
// block once it's supplied at all.
ActiveDirectorySettingsCreate = generated.ActiveDirectorySettingsCreate
// ActiveDirectorySettingsUpdate “active_directory_settings“ on update — every field optional.
//
// Only meaningful when the *effective* “ad_create_machine_record“ (this
// patch's, if supplied, else the stored row's) is true. The merged-state
// requirement that all three fields end up non-null when
// “ad_create_machine_record“ is true applies here too, since a patch may
// only supply part of the block.
ActiveDirectorySettingsUpdate = generated.ActiveDirectorySettingsUpdate
// ActiveUsersTimeSeries defines model for ActiveUsersTimeSeries.
ActiveUsersTimeSeries = generated.ActiveUsersTimeSeries
// AdUserManagementConfigSummary One AD user-management sync config (an
// “active_directory_user_management_configs“ row) -- maps local/SAML/OIDC
// accounts to an LDAP config for account lifecycle management (e.g. random
// password rotation on login).
AdUserManagementConfigSummary = generated.AdUserManagementConfigSummary
// AddGroupImageRequest defines model for AddGroupImageRequest.
AddGroupImageRequest = generated.AddGroupImageRequest
// AddGroupMemberRequest defines model for AddGroupMemberRequest.
AddGroupMemberRequest = generated.AddGroupMemberRequest
// AdminSessionListResponse “GET /api/admin/session/sessions“.
AdminSessionListResponse = generated.AdminSessionListResponse
// AdminSessionListResponseSortDirection defines model for AdminSessionListResponse.SortDirection.
AdminSessionListResponseSortDirection = generated.AdminSessionListResponseSortDirection
// AdminSessionSummary A session as an administrator sees it: the owner's view plus owner and
// host blocks, and the egress gateway/credential summaries the caller is
// permitted to see (secrets never included).
AdminSessionSummary = generated.AdminSessionSummary
// AgentReportRow defines model for AgentReportRow.
AgentReportRow = generated.AgentReportRow
// AgentUtilizationTimeSeries Per-bucket agent resource utilization; series names match the
// “_agent_resource_utilization“ query columns (percentages, °C for temp).
AgentUtilizationTimeSeries = generated.AgentUtilizationTimeSeries
// ApiConfigCreated Create response: the summary plus the one-time secret.
ApiConfigCreated = generated.ApiConfigCreated
// ApiConfigPermissionGrant One permission granted to a developer API key config. The same shape as “PermissionGrant“,
// with “api_id“ in place of “group_id“.
ApiConfigPermissionGrant = generated.ApiConfigPermissionGrant
// ApiConfigSummary One developer API key config (“Api“ ORM “@Jsonable“ field set).
ApiConfigSummary = generated.ApiConfigSummary
// AppserverServiceIntent What the operator decided for an appserver service.
//
// Independent of liveness: a service can be `disabled` and `stopped` at once.
AppserverServiceIntent = generated.AppserverServiceIntent
// AppserverServiceServerRef An agent attached to the service.
AppserverServiceServerRef = generated.AppserverServiceServerRef
// AppserverServiceSummary One appserver service: a process that serves the Kasm API, processes background
// jobs, or both.
AppserverServiceSummary = generated.AppserverServiceSummary
// AppserverServiceType defines model for AppserverServiceType.
AppserverServiceType = generated.AppserverServiceType
// AssignPhysicalTokenRequest Body for “POST .../physical-tokens/{serial_number}/assign“.
AssignPhysicalTokenRequest = generated.AssignPhysicalTokenRequest
// AssignServerUserRequest defines model for AssignServerUserRequest.
AssignServerUserRequest = generated.AssignServerUserRequest
// AssignedServerRef Inline server reference for server-pool-assigned images.
AssignedServerRef = generated.AssignedServerRef
// AutoscaleConfigRef defines model for AutoscaleConfigRef.
AutoscaleConfigRef = generated.AutoscaleConfigRef
// AutoscaleConfigSummary One autoscale configuration, as returned by both read endpoints.
AutoscaleConfigSummary = generated.AutoscaleConfigSummary
// AutoscaleImportEnabledMode What happens to the “enabled“ flag on imported AutoScale configs.
AutoscaleImportEnabledMode = generated.AutoscaleImportEnabledMode
// AutoscaleType defines model for AutoscaleType.
AutoscaleType = generated.AutoscaleType
// AutoscaledServerCounts AutoScale-provisioned resources a deployment-config import replaces.
AutoscaledServerCounts = generated.AutoscaledServerCounts
// AwsDnsProvider `GET` response for an AWS DNS provider.
AwsDnsProvider = generated.AwsDnsProvider
// AwsDnsProviderDnsProviderName defines model for AwsDnsProvider.DnsProviderName.
AwsDnsProviderDnsProviderName = generated.AwsDnsProviderDnsProviderName
// AwsDnsProviderCreate `POST` body for an AWS DNS provider.
AwsDnsProviderCreate = generated.AwsDnsProviderCreate
// AwsDnsProviderCreateDnsProviderName defines model for AwsDnsProviderCreate.DnsProviderName.
AwsDnsProviderCreateDnsProviderName = generated.AwsDnsProviderCreateDnsProviderName
// AwsDnsProviderUpdate `PATCH` body for an AWS DNS provider. Every field optional.
AwsDnsProviderUpdate = generated.AwsDnsProviderUpdate
// AwsDnsProviderUpdateDnsProviderName defines model for AwsDnsProviderUpdate.DnsProviderName.
AwsDnsProviderUpdateDnsProviderName = generated.AwsDnsProviderUpdateDnsProviderName
// AwsVmConfig `GET` response for an AWS VM provider config.
AwsVmConfig = generated.AwsVmConfig
// AwsVmConfigVmProviderName defines model for AwsVmConfig.VmProviderName.
AwsVmConfigVmProviderName = generated.AwsVmConfigVmProviderName
// AwsVmConfigCreate `POST` body for an AWS VM provider config.
AwsVmConfigCreate = generated.AwsVmConfigCreate
// AwsVmConfigCreateVmProviderName defines model for AwsVmConfigCreate.VmProviderName.
AwsVmConfigCreateVmProviderName = generated.AwsVmConfigCreateVmProviderName
// AwsVmConfigUpdate `PATCH` body for an AWS VM provider config. Every field optional.
AwsVmConfigUpdate = generated.AwsVmConfigUpdate
// AwsVmConfigUpdateVmProviderName defines model for AwsVmConfigUpdate.VmProviderName.
AwsVmConfigUpdateVmProviderName = generated.AwsVmConfigUpdateVmProviderName
// AzureDnsProvider `GET` response for an Azure DNS provider.
AzureDnsProvider = generated.AzureDnsProvider
// AzureDnsProviderAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureDnsProviderAzureAuthority = generated.AzureDnsProviderAzureAuthority
// AzureDnsProviderDnsProviderName defines model for AzureDnsProvider.DnsProviderName.
AzureDnsProviderDnsProviderName = generated.AzureDnsProviderDnsProviderName
// AzureDnsProviderCreate `POST` body for an Azure DNS provider.
AzureDnsProviderCreate = generated.AzureDnsProviderCreate
// AzureDnsProviderCreateAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureDnsProviderCreateAzureAuthority = generated.AzureDnsProviderCreateAzureAuthority
// AzureDnsProviderCreateDnsProviderName defines model for AzureDnsProviderCreate.DnsProviderName.
AzureDnsProviderCreateDnsProviderName = generated.AzureDnsProviderCreateDnsProviderName
// AzureDnsProviderUpdate `PATCH` body for an Azure DNS provider. Every field optional.
AzureDnsProviderUpdate = generated.AzureDnsProviderUpdate
// AzureDnsProviderUpdateAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureDnsProviderUpdateAzureAuthority = generated.AzureDnsProviderUpdateAzureAuthority
// AzureDnsProviderUpdateDnsProviderName defines model for AzureDnsProviderUpdate.DnsProviderName.
AzureDnsProviderUpdateDnsProviderName = generated.AzureDnsProviderUpdateDnsProviderName
// AzureVmConfig `GET` response for an Azure VM provider config.
AzureVmConfig = generated.AzureVmConfig
// AzureVmConfigAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureVmConfigAzureAuthority = generated.AzureVmConfigAzureAuthority
// AzureVmConfigVmProviderName defines model for AzureVmConfig.VmProviderName.
AzureVmConfigVmProviderName = generated.AzureVmConfigVmProviderName
// AzureVmConfigCreate `POST` body for an Azure VM provider config.
AzureVmConfigCreate = generated.AzureVmConfigCreate
// AzureVmConfigCreateAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureVmConfigCreateAzureAuthority = generated.AzureVmConfigCreateAzureAuthority
// AzureVmConfigCreateVmProviderName defines model for AzureVmConfigCreate.VmProviderName.
AzureVmConfigCreateVmProviderName = generated.AzureVmConfigCreateVmProviderName
// AzureVmConfigUpdate `PATCH` body for an Azure VM provider config. Every field optional.
AzureVmConfigUpdate = generated.AzureVmConfigUpdate
// AzureVmConfigUpdateAzureAuthority Which Azure cloud authority to authenticate against: public cloud, government, China, or Germany.
AzureVmConfigUpdateAzureAuthority = generated.AzureVmConfigUpdateAzureAuthority
// AzureVmConfigUpdateVmProviderName defines model for AzureVmConfigUpdate.VmProviderName.
AzureVmConfigUpdateVmProviderName = generated.AzureVmConfigUpdateVmProviderName
// BannerConfig Appearance and behavior of a session banner.
BannerConfig = generated.BannerConfig
// BannerSize Pixel insets the banner reserves on each edge of the session viewport.
BannerSize = generated.BannerSize
// BannerSummary One banner, as returned by the list, create and patch endpoints.
BannerSummary = generated.BannerSummary
// BatchContextualError A validation error that involves the named fields of a row, or the whole file.
BatchContextualError = generated.BatchContextualError
// BatchCreateServersResources defines model for BatchCreateServersResources.
BatchCreateServersResources = generated.BatchCreateServersResources
// BatchCreateServersResponse defines model for BatchCreateServersResponse.
BatchCreateServersResponse = generated.BatchCreateServersResponse
// BatchCreateUsersResources defines model for BatchCreateUsersResources.
BatchCreateUsersResources = generated.BatchCreateUsersResources
// BatchCreateUsersResponse “POST /api/admin/identity/users/batch“ response.
//
// Always includes both “csv_validation_data“ (per-row report) and
// “resources“ (the created users, “None“ when row-level errors
// prevented any creation).
BatchCreateUsersResponse = generated.BatchCreateUsersResponse
// BatchCreatedUserSummary The user created for one batch row, with its group memberships.
BatchCreatedUserSummary = generated.BatchCreatedUserSummary
// BatchCsvValidationData The result of validating an uploaded CSV file: its headers, every row with its errors, and
// the errors that apply to the file as a whole.
BatchCsvValidationData = generated.BatchCsvValidationData
// BatchFieldError A validation error on one field of a CSV row.
BatchFieldError = generated.BatchFieldError
// BatchValidatedField One field of a validated CSV row. “error“ is absent when the field is valid.
BatchValidatedField = generated.BatchValidatedField
// BatchValidatedRow One validated CSV row: its fields and the errors found in it.
BatchValidatedRow = generated.BatchValidatedRow
// BillingInfo Stripe pricing-table configuration plus the customer portal link.
BillingInfo = generated.BillingInfo
// BrandingConfigSummary One branding config, as returned by every branding read/write
// endpoint.
BrandingConfigSummary = generated.BrandingConfigSummary
// BrowserLoginResponse “POST /api/session/sessions/{session_id}/browser-logins“: a fresh login-session
// JWT and connect URL for an existing session (was the credential half of
// “get_kasm_status“). Every call persists a new “session_tokens“ row;
// status polling never carries credentials.
BrowserLoginResponse = generated.BrowserLoginResponse
// COMPONENTOPERATIONALSTATUS defines model for COMPONENT_OPERATIONAL_STATUS.
COMPONENTOPERATIONALSTATUS = generated.COMPONENTOPERATIONALSTATUS
// CONNECTIONPROXYTYPE defines model for CONNECTION_PROXY_TYPE.
CONNECTIONPROXYTYPE = generated.CONNECTIONPROXYTYPE
// CPUALLOCATIONMETHOD defines model for CPU_ALLOCATION_METHOD.
CPUALLOCATIONMETHOD = generated.CPUALLOCATIONMETHOD
// CaptchaRequiredProblem A cast claim needs a solved CAPTCHA (missing, failed, or the link
// requires one the deployment has not configured). “captcha_type“ and
// “recaptcha_site_key“ are what the launcher needs to render the widget;
// both are “null“ when no verifier is configured.
CaptchaRequiredProblem = generated.CaptchaRequiredProblem
// CaptchaRequiredProblemType defines model for CaptchaRequiredProblem.Type.
CaptchaRequiredProblemType = generated.CaptchaRequiredProblemType
// CastClaimAccepted “202“ from a successful claim: the session request was accepted.
//
// “resumed“ is set when “allow_resume“ matched an existing session for the
// caller. “login_token“ is minted only for anonymous claims and is carried
// to the route **out of band**: it is excluded from serialisation (and so from
// the wire body and the OpenAPI schema). For an unauthenticated browser claim
// the route turns it into the “session_token“ cookie on the 202 (refinement
// decision #8 — the token's rename is deferred); the browser then navigates
// to the ordinary session view for “session_id“, and “viewer_options“ are
// the link's flags for that page.
//
// An API key holding “USERS_AUTH_SESSION“ that claims anonymously gets the
// *same* JWT in the body instead: “username“, “session_token“,
// “connect_url“ (“/#/connect/cast/{session_id}/{user_id}/{session_token}“
// plus the viewer-option query) and “expires_at“. No second token is
// minted; the route serialises the one the claim created.
CastClaimAccepted = generated.CastClaimAccepted
// CastClaimEntry One claim made through a cast link.
CastClaimEntry = generated.CastClaimEntry
// CastClaimOutcome defines model for CastClaimOutcome.
CastClaimOutcome = generated.CastClaimOutcome
// CastClaimRequest “POST /api/session/cast-links/{key}/claims“.
//
// “query_args“ are the launch URL's own parameters (forwarded into
// “connection_info“ via “CastLink.generate_connection_info“).
// “session_url“ and “docker_network“ are honoured only when the link
// allows dynamic values for them. The referrer allow-list is evaluated on
// the “Referer“/“Origin“ headers the route passes in, not on a body
// field; it is browser-enforced only and not a security boundary.
CastClaimRequest = generated.CastClaimRequest
// CastClaimsPage defines model for CastClaimsPage.
CastClaimsPage = generated.CastClaimsPage
// CastLinkClientSettings The “allow_kasm_*“ client-setting overrides a cast link may enforce.
//
// Every field is tri-state: “None“ means "do not override the group setting".
CastLinkClientSettings = generated.CastLinkClientSettings
// CastLinkDescription “GET /api/session/cast-links/{key}“: what the launcher page needs before claiming.
//
// Branding, the image summary, the derived link “state“, which parameters
// the link accepts, and the caller's outstanding “requirements“ so the
// client collects a captcha, a login and the launch form up front instead
// of discovering them one at a time on the claim's 4xx. Nothing here is
// secret; the link is public by definition. Side-effect free.
CastLinkDescription = generated.CastLinkDescription
// CastLinkKeyRotation “POST /api/admin/session/cast-links/{cast_link_id}/key-rotations“.
CastLinkKeyRotation = generated.CastLinkKeyRotation
// CastLinkList “GET /api/admin/session/cast-links“.
CastLinkList = generated.CastLinkList
// CastLinkListSortDirection defines model for CastLinkList.SortDirection.
CastLinkListSortDirection = generated.CastLinkListSortDirection
// CastLinkState defines model for CastLinkState.
CastLinkState = generated.CastLinkState
// CastLinkSummary One cast link as the admin sees it, with its current “state“.
CastLinkSummary = generated.CastLinkSummary
// CastRequirement What a visitor still has to supply before a claim can be accepted.
CastRequirement = generated.CastRequirement
// CastViewerOptions Viewer options the link imposes on the session page.
CastViewerOptions = generated.CastViewerOptions
// ChangePasswordRequest Body for “PUT /api/auth/password“.
//
// The second-factor fields carry whichever factor the account has enrolled; the change is
// refused when that factor is missing.
ChangePasswordRequest = generated.ChangePasswordRequest
// ClearSecondFactorRequest Body for “DELETE /api/auth/second-factor“.
//
// Clearing an enrolled factor re-verifies the password and the factor being
// cleared: exactly one of “code“ (TOTP) or “webauthn_credential“.
ClearSecondFactorRequest = generated.ClearSecondFactorRequest
// ClientSettings The effective client-facing session settings for the authenticated
// user. A boolean setting is “null“ when no group defines it.
ClientSettings = generated.ClientSettings
// CompanySummary One company record, as returned by every company read/write endpoint.
CompanySummary = generated.CompanySummary
// ConfigExport Response of “POST /api/admin/platform/config-exports“.
ConfigExport = generated.ConfigExport
// ConfigExportMode Which slice of the deployment an export covers.
ConfigExportMode = generated.ConfigExportMode
// ConfigImportFormat Encoding of the uploaded import payload.
ConfigImportFormat = generated.ConfigImportFormat
// ConfigImportPreview Response of “POST /api/admin/platform/config-imports/preview“.
ConfigImportPreview = generated.ConfigImportPreview
// ConfigSchema Response of “GET /api/admin/platform/config-schema“.
ConfigSchema = generated.ConfigSchema
// ConnectionCredentialType defines model for ConnectionCredentialType.
ConnectionCredentialType = generated.ConnectionCredentialType
// ConnectionProxySummary One connection-proxy entry, as returned by every connection-proxy
// read/write endpoint.
ConnectionProxySummary = generated.ConnectionProxySummary
// ConnectionType defines model for ConnectionType.
ConnectionType = generated.ConnectionType
// CreateAdUserManagementConfigRequest Body for “POST /api/admin/identity/ad-user-management-configs“.
//
// Exactly one of “local_accounts“/“saml_id“/“oidc_id“ must name the
// account source; “user_container_dn“ is required when
// “enable_create_user“ is set. Both are validated by the service against
// DB state (the linked LDAP/SAML/OIDC config, and any existing sync config
// already targeting the same account source), not here.
CreateAdUserManagementConfigRequest = generated.CreateAdUserManagementConfigRequest
// CreateApiConfigRequest Body for “POST /api/admin/identity/api-configs“.
//
// “expires“ accepts RFC 3339 or “YYYY-MM-DD HH:MM:SS“; “null“ means "never expires".
CreateApiConfigRequest = generated.CreateApiConfigRequest
// CreateAutoscaleConfigRequest Request body for “POST /api/admin/infrastructure/autoscale-configs“.
//
// Common fields sit at the top level; the type-specific ones nest under
// “docker_agent_settings“ / “server_pool_settings“, and exactly the block
// matching “autoscale_type“ must be supplied.
CreateAutoscaleConfigRequest = generated.CreateAutoscaleConfigRequest
// CreateBannerRequest Request body for “POST /api/admin/platform/banners“.
CreateBannerRequest = generated.CreateBannerRequest
// CreateBrandingConfigRequest Request body for `POST /api/admin/tenant/branding-configs`.
CreateBrandingConfigRequest = generated.CreateBrandingConfigRequest
// CreateCastLinkRequest “POST /api/admin/session/cast-links“. The key is server-generated
// (“secrets.token_urlsafe(16)“) unless supplied.
CreateCastLinkRequest = generated.CreateCastLinkRequest
// CreateCompanyRequest Request body for `POST /api/admin/tenant/companies`.
CreateCompanyRequest = generated.CreateCompanyRequest
// CreateConfigExportRequest Body of “POST /api/admin/platform/config-exports“.
CreateConfigExportRequest = generated.CreateConfigExportRequest
// CreateConfigImportRequest Body of “POST /api/admin/platform/config-imports“.
CreateConfigImportRequest = generated.CreateConfigImportRequest
// CreateConfigImportRequestLdapMappings0 defines model for CreateConfigImportRequest.LdapMappings.0.
CreateConfigImportRequestLdapMappings0 = generated.CreateConfigImportRequestLdapMappings0
// CreateConfigImportRequestLdapMappings1 defines model for CreateConfigImportRequest.LdapMappings.1.
CreateConfigImportRequestLdapMappings1 = generated.CreateConfigImportRequestLdapMappings1
// CreateConfigImportRequest_LdapMappings_AdditionalProperties defines model for CreateConfigImportRequest.ldap_mappings.AdditionalProperties.
CreateConfigImportRequest_LdapMappings_AdditionalProperties = generated.CreateConfigImportRequest_LdapMappings_AdditionalProperties
// CreateConfigImportRequestZoneMappings0 defines model for CreateConfigImportRequest.ZoneMappings.0.
CreateConfigImportRequestZoneMappings0 = generated.CreateConfigImportRequestZoneMappings0
// CreateConfigImportRequestZoneMappings1 defines model for CreateConfigImportRequest.ZoneMappings.1.
CreateConfigImportRequestZoneMappings1 = generated.CreateConfigImportRequestZoneMappings1
// CreateConfigImportRequest_ZoneMappings_AdditionalProperties defines model for CreateConfigImportRequest.zone_mappings.AdditionalProperties.
CreateConfigImportRequest_ZoneMappings_AdditionalProperties = generated.CreateConfigImportRequest_ZoneMappings_AdditionalProperties
// CreateConnectionProxyRequest Request body for `POST /api/admin/security/connection-proxies`.
CreateConnectionProxyRequest = generated.CreateConnectionProxyRequest
// CreateDnsProviderRequest “POST“ request body: the create union, named for the spec.
//
// Wraps :data:`AnyCreateDnsProvider`. “*Request“ matches the naming
// every other migrated domain uses for a write body
// (“CreateAutoscaleConfigRequest“, “CreateZoneRequest“,
// “CreateImageRequest“, ...), which is why the alias carries the “Any“
// prefix rather than this class carrying a “*Body“ suffix.
CreateDnsProviderRequest = generated.CreateDnsProviderRequest
// CreateEgressCredentialRequest Request body for “POST /api/admin/providers/egress-credentials“.
//
// Exactly one of “user_id“/“group_id“/“image_id“ must be set, and
// exactly one of “password“/“wireguard_private_key“/“tailscale_key“/
// “custom_credential“ must be set.
CreateEgressCredentialRequest = generated.CreateEgressCredentialRequest
// CreateEgressGatewayRequest Request body for “POST /api/admin/providers/egress-gateways“.
CreateEgressGatewayRequest = generated.CreateEgressGatewayRequest
// CreateEgressProviderMappingRequest Request body for “POST /api/admin/providers/egress-provider-mappings“.
//
// Exactly one of “user_id“/“group_id“/“image_id“ must be set.
CreateEgressProviderMappingRequest = generated.CreateEgressProviderMappingRequest
// CreateEgressProviderRequest Request body for “POST /api/admin/providers/egress-providers“.
CreateEgressProviderRequest = generated.CreateEgressProviderRequest
// CreateFileMappingRequest defines model for CreateFileMappingRequest.
CreateFileMappingRequest = generated.CreateFileMappingRequest
// CreateFileMappingRequestFileType defines model for CreateFileMappingRequest.FileType.
CreateFileMappingRequestFileType = generated.CreateFileMappingRequestFileType
// CreateGroupRequest Body for “POST /api/admin/identity/groups“.
//
// The optional fields have no distinct “null“ state on create (an omitted
// “description“ already stores NULL, “group_metadata“ defaults to “{}“,
// “group_id“ is generated), so an explicit “null“ is rejected (422) and
// “strip_null_from_schema“ keeps the spec from advertising it.
CreateGroupRequest = generated.CreateGroupRequest
// CreateGroupSettingRequest Override a catalog setting for one group. “group_setting_id“ names the
// catalog (“group_id“ null) row whose name, type and description the
// override inherits.
CreateGroupSettingRequest = generated.CreateGroupSettingRequest
// CreateImageFromSessionRequest The create-image-from-session request body — the kasm to snapshot plus
// the target docker image/registry details. No “{target_kasm: ...}“ envelope.
CreateImageFromSessionRequest = generated.CreateImageFromSessionRequest
// CreateImageRequest The create-image request body; the update body is the same payload with every field
// optional.
//
// Beyond “friendly_name“ and the target the image type needs, every field is optional, and
// an omitted field is left at its default. Unknown fields are ignored.
CreateImageRequest = generated.CreateImageRequest
// CreateLdapConfigRequest Body for “POST /api/admin/identity/ldap-configs“.
//
// Missing required fields are rejected with 422.
CreateLdapConfigRequest = generated.CreateLdapConfigRequest
// CreateLicenseRequest Register a license, either from a signed key or by activating.
//
// Exactly one of `license_key`/`activation_key` is required. A `license_key`
// whose decoded `key_type` is "activation" is routed to the activation flow
// by the service -- the admin UI posts activation keys in this field.
CreateLicenseRequest = generated.CreateLicenseRequest
// CreateNetworkPolicyRequest defines model for CreateNetworkPolicyRequest.
CreateNetworkPolicyRequest = generated.CreateNetworkPolicyRequest
// CreateOidcConfigRequest Body for “POST /api/admin/identity/oidc-configs“.
//
// Missing required fields are rejected with 422. “scope“ matches the
// response shape (“list[str]“); the service joins it for the stored column
// (empty list -> “""“). The server assigns “oidc_id“; clients may not
// choose a primary key on create.
CreateOidcConfigRequest = generated.CreateOidcConfigRequest
// CreateRegistryRequest Request body for `POST /api/admin/catalog/registries`. `registry` is
// the bootstrap URL of the registry to install.
CreateRegistryRequest = generated.CreateRegistryRequest
// CreateSamlConfigRequest Body for “POST /api/admin/identity/saml-configs“.
//
// The security flags and signature/digest algorithms are not client fields;
// they are server-set defaults (see “SsoConfigService.create_saml_config“). The server assigns “saml_id“;
// clients may not choose a primary key on create.
CreateSamlConfigRequest = generated.CreateSamlConfigRequest
// CreateScheduleRequest Request body for “POST /api/admin/infrastructure/autoscale-schedules“.
//
// Fields sit at the top level of the body. “timezone“ is an IANA name,
// validated against the system tz database — an unknown name is a 400.
CreateScheduleRequest = generated.CreateScheduleRequest
// CreateServerPoolRequest Request body for “POST /api/admin/infrastructure/server-pools“.
CreateServerPoolRequest = generated.CreateServerPoolRequest
// CreateServerRequest defines model for CreateServerRequest.
CreateServerRequest = generated.CreateServerRequest
// CreateServerTemplateRequest Request body for `POST /api/admin/catalog/server-templates`.
CreateServerTemplateRequest = generated.CreateServerTemplateRequest
// CreateSessionTokenRequest Body for “POST /api/admin/identity/session-tokens“.
CreateSessionTokenRequest = generated.CreateSessionTokenRequest
// CreateSsoAttributeMappingRequest Body for “POST .../sso-configs/{sso_id}/attribute-mappings“. The
// target SSO config comes from the path; it may be an LDAP, SAML, or OIDC
// config -- the service resolves which.
CreateSsoAttributeMappingRequest = generated.CreateSsoAttributeMappingRequest
// CreateSsoGroupMappingRequest Body for “POST /api/admin/identity/sso-group-mappings“.
CreateSsoGroupMappingRequest = generated.CreateSsoGroupMappingRequest
// CreateStagingConfigRequest Request body for `POST /api/admin/catalog/staging-configs`.
CreateStagingConfigRequest = generated.CreateStagingConfigRequest
// CreateStorageMappingRequest Request body for `POST /api/providers/storage-mappings` (providers that
// do not use an OAuth login). `name` defaults to
// `"<provider name> Storage Mapping"`.
CreateStorageMappingRequest = generated.CreateStorageMappingRequest
// CreateStorageProviderRequest Request body for `POST /api/admin/providers/storage-providers`.
//
// Which optional fields a given provider type requires (OAuth client
// settings, `webdav_url`, `root_drive_url`, `volume_config` keys) is
// checked by that type's plugin against the DB-backed configuration and
// reported as a 400.
CreateStorageProviderRequest = generated.CreateStorageProviderRequest
// CreateSupportBundleRequest Request body for “POST /api/admin/platform/support-bundles“.
CreateSupportBundleRequest = generated.CreateSupportBundleRequest
// CreateUserRequest The create-user request body — the body *is* the user payload, with no
// “{target_user: ...}“ envelope.
CreateUserRequest = generated.CreateUserRequest
// CreateUserRequestRealm defines model for CreateUserRequest.Realm.
CreateUserRequestRealm = generated.CreateUserRequestRealm
// CreateVmProviderConfigRequest “POST“ request body: the create union, named for the spec.
//
// Wraps :data:`AnyCreateVmProviderConfig`. “*Request“ matches the naming
// every other migrated domain uses for a write body
// (“CreateAutoscaleConfigRequest“, “CreateZoneRequest“,
// “CreateImageRequest“, ...), which is why the alias carries the “Any“
// prefix rather than this class carrying a “*Body“ suffix.
CreateVmProviderConfigRequest = generated.CreateVmProviderConfigRequest
// CreateWebFilterPolicyRequest Body for “POST /api/admin/security/web-filter-policies“.
CreateWebFilterPolicyRequest = generated.CreateWebFilterPolicyRequest
// CreateZoneRequest The create-zone request body. “zone_name“ is required; every other field is optional.
CreateZoneRequest = generated.CreateZoneRequest
// CreateZoneRequestProxyLoadStrategy defines model for CreateZoneRequest.ProxyLoadStrategy.
CreateZoneRequestProxyLoadStrategy = generated.CreateZoneRequestProxyLoadStrategy
// DefaultImages “GET /api/platform/default-images“ response.
//
// Field names have no “_id“ suffix for wire compatibility; values are
// canonical dashed UUIDs.
DefaultImages = generated.DefaultImages
// DeleteAgentSessionsResponse “POST /api/admin/session/session-deletions“ (202).
DeleteAgentSessionsResponse = generated.DeleteAgentSessionsResponse
// DigitalOceanDnsProvider `GET` response for a DigitalOcean DNS provider.
DigitalOceanDnsProvider = generated.DigitalOceanDnsProvider
// DigitalOceanDnsProviderDnsProviderName defines model for DigitalOceanDnsProvider.DnsProviderName.
DigitalOceanDnsProviderDnsProviderName = generated.DigitalOceanDnsProviderDnsProviderName
// DigitalOceanDnsProviderCreate `POST` body for a DigitalOcean DNS provider.
DigitalOceanDnsProviderCreate = generated.DigitalOceanDnsProviderCreate
// DigitalOceanDnsProviderCreateDnsProviderName defines model for DigitalOceanDnsProviderCreate.DnsProviderName.
DigitalOceanDnsProviderCreateDnsProviderName = generated.DigitalOceanDnsProviderCreateDnsProviderName
// DigitalOceanDnsProviderUpdate `PATCH` body for a DigitalOcean DNS provider. Every field optional.
DigitalOceanDnsProviderUpdate = generated.DigitalOceanDnsProviderUpdate
// DigitalOceanDnsProviderUpdateDnsProviderName defines model for DigitalOceanDnsProviderUpdate.DnsProviderName.
DigitalOceanDnsProviderUpdateDnsProviderName = generated.DigitalOceanDnsProviderUpdateDnsProviderName
// DigitalOceanVmConfig `GET` response for a DigitalOcean VM provider config.
DigitalOceanVmConfig = generated.DigitalOceanVmConfig
// DigitalOceanVmConfigVmProviderName defines model for DigitalOceanVmConfig.VmProviderName.
DigitalOceanVmConfigVmProviderName = generated.DigitalOceanVmConfigVmProviderName
// DigitalOceanVmConfigCreate `POST` body for a DigitalOcean VM provider config.
DigitalOceanVmConfigCreate = generated.DigitalOceanVmConfigCreate
// DigitalOceanVmConfigCreateVmProviderName defines model for DigitalOceanVmConfigCreate.VmProviderName.
DigitalOceanVmConfigCreateVmProviderName = generated.DigitalOceanVmConfigCreateVmProviderName
// DigitalOceanVmConfigUpdate `PATCH` body for a DigitalOcean VM provider config. Every field optional.
DigitalOceanVmConfigUpdate = generated.DigitalOceanVmConfigUpdate
// DigitalOceanVmConfigUpdateVmProviderName defines model for DigitalOceanVmConfigUpdate.VmProviderName.
DigitalOceanVmConfigUpdateVmProviderName = generated.DigitalOceanVmConfigUpdateVmProviderName
// DnsProviderName A DNS provider that has its own table.
DnsProviderName = generated.DnsProviderName
// DnsProviderResponse Response body for a single DNS provider config: the tagged union, named.
//
// Wraps :data:`AnyDnsProvider` so the “oneOf“/“discriminator“ schema
// gets its own entry in “components/schemas“ rather than being inlined
// per operation.
DnsProviderResponse = generated.DnsProviderResponse
// DnsProviderSummary Inline DNS-provider reference embedded in an autoscale config.
//
// Carries the id plus “dns_provider_name“ -- the pair the DNS routes need
// to fetch the config -- and the human-readable provider name.
DnsProviderSummary = generated.DnsProviderSummary
// DockerAgentSettings Fields that apply only to a “DOCKER_AGENT“ config.
DockerAgentSettings = generated.DockerAgentSettings
// DockerAgentSettingsCreate “docker_agent_settings“ on create.
//
// “agent_cores_override“ and “agent_memory_override_bytes“ are required
// and must be positive.
//
// “register_dns“ defaults to “False“ and cannot be sent as an explicit
// “null“. Setting it “True“ requires a non-blank “base_domain_name“.
DockerAgentSettingsCreate = generated.DockerAgentSettingsCreate
// DockerAgentSettingsUpdate “docker_agent_settings“ on update — every field optional, and an
// explicit “null“ on “standby_cores“/“standby_memory_bytes“/
// “standby_gpus“ (the block's NOT-NULL columns) is a 422.
//
// “register_dns“/“base_domain_name“ stay nullable here — either may be
// cleared independently on an existing row — but the merged post-patch
// state still can't hold “register_dns=True“ with a blank
// “base_domain_name“.
DockerAgentSettingsUpdate = generated.DockerAgentSettingsUpdate
// DomainUsageRow defines model for DomainUsageRow.
DomainUsageRow = generated.DomainUsageRow
// EgressCredentialListItem Per-credential entry in the egress-credential list response — adds
// the denormalized provider/gateway references for display.
EgressCredentialListItem = generated.EgressCredentialListItem
// EgressCredentialSummary Per-credential entry in the egress-credential list/create/update responses.
EgressCredentialSummary = generated.EgressCredentialSummary
// EgressGatewayOption A gateway the caller may pick when launching a workspace image,
// paired with the credential that authorizes its use.
EgressGatewayOption = generated.EgressGatewayOption
// EgressGatewayRef Minimal reference to an egress gateway, embedded in mapping/credential list responses.
EgressGatewayRef = generated.EgressGatewayRef
// EgressGatewaySummary Per-gateway entry in the egress-gateway list/create/update responses.
EgressGatewaySummary = generated.EgressGatewaySummary
// EgressProviderMappingListItem Per-mapping entry in the egress-provider-mapping list response — adds
// the denormalized provider/gateway references for display.
EgressProviderMappingListItem = generated.EgressProviderMappingListItem
// EgressProviderMappingSummary Per-mapping entry in the egress-provider-mapping create/update responses.
EgressProviderMappingSummary = generated.EgressProviderMappingSummary
// EgressProviderOption A gateway-less (e.g. OpenZiti) egress provider the caller has access
// to for a workspace image.
EgressProviderOption = generated.EgressProviderOption
// EgressProviderRef Minimal reference to an egress provider, embedded in mapping/credential list responses.
EgressProviderRef = generated.EgressProviderRef
// EgressProviderSummary Per-provider entry in the egress-provider list/create/update responses.
EgressProviderSummary = generated.EgressProviderSummary
// EgressProviderType The VPN protocol or mechanism an egress provider uses.
EgressProviderType = generated.EgressProviderType
// EgressProviderZitiConfigSummary The OpenZiti admin identity configuration for a Ziti-type egress provider.
EgressProviderZitiConfigSummary = generated.EgressProviderZitiConfigSummary
// EgressSelectionRequiredProblem The caller has egress gateways or providers to choose from and chose none.
EgressSelectionRequiredProblem = generated.EgressSelectionRequiredProblem
// EgressSelectionRequiredProblemType defines model for EgressSelectionRequiredProblem.Type.
EgressSelectionRequiredProblemType = generated.EgressSelectionRequiredProblemType
// ExecConfig A command the agent runs in the container with “docker exec“.
ExecConfig = generated.ExecConfig
// ExecutionCommandAccepted “POST .../execution-commands“ (202): the command ran, or is queued.
//
// “queued“ says which. A container that is serving runs the command before
// this returns; one that is still coming up -- starting, being placed, being
// resumed -- takes it into “queued_tasks“ and the reconciler runs it the
// moment the container is serving. “command“ is the name for a named
// command and “None“ for a free-form one.
ExecutionCommandAccepted = generated.ExecutionCommandAccepted
// ExecutionCommandRequest “POST .../execution-commands“: run a command in the session.
//
// Exactly one of two forms. “command“ names one of the image's exec configs
// and “url“ is the parameter of its “go“ command (opens the URL in the
// session). “exec“ is a free-form command -- the developer API's
// “exec_config“ -- and needs the “SESSIONS_MODIFY“ scope; a plain user
// token may only name what the image defines.
ExecutionCommandRequest = generated.ExecutionCommandRequest
// ExperimentalFeatures “GET /api/admin/platform/experimental-features“ response.
ExperimentalFeatures = generated.ExperimentalFeatures
// FacetCount defines model for FacetCount.
FacetCount = generated.FacetCount
// FileMappingContentReplace defines model for FileMappingContentReplace.
FileMappingContentReplace = generated.FileMappingContentReplace
// FileMappingSummary defines model for FileMappingSummary.
FileMappingSummary = generated.FileMappingSummary
// FileMappingUpload defines model for FileMappingUpload.
FileMappingUpload = generated.FileMappingUpload
// GPUGRAPHICSACCELERATION defines model for GPU_GRAPHICS_ACCELERATION.
GPUGRAPHICSACCELERATION = generated.GPUGRAPHICSACCELERATION
// GPUVIDEOENCODING defines model for GPU_VIDEO_ENCODING.
GPUVIDEOENCODING = generated.GPUVIDEOENCODING
// GcpDnsProvider `GET` response for a GCP DNS provider.
GcpDnsProvider = generated.GcpDnsProvider
// GcpDnsProviderDnsProviderName defines model for GcpDnsProvider.DnsProviderName.
GcpDnsProviderDnsProviderName = generated.GcpDnsProviderDnsProviderName
// GcpDnsProviderGcpCredentials0 defines model for GcpDnsProvider.GcpCredentials.0.
GcpDnsProviderGcpCredentials0 = generated.GcpDnsProviderGcpCredentials0
// GcpDnsProviderGcpCredentials1 defines model for GcpDnsProvider.GcpCredentials.1.
GcpDnsProviderGcpCredentials1 = generated.GcpDnsProviderGcpCredentials1
// GcpDnsProvider_GcpCredentials GCP service-account credentials, masked. `{}` if none are set.
GcpDnsProvider_GcpCredentials = generated.GcpDnsProvider_GcpCredentials
// GcpDnsProviderCreate `POST` body for a GCP DNS provider.
GcpDnsProviderCreate = generated.GcpDnsProviderCreate
// GcpDnsProviderCreateDnsProviderName defines model for GcpDnsProviderCreate.DnsProviderName.
GcpDnsProviderCreateDnsProviderName = generated.GcpDnsProviderCreateDnsProviderName
// GcpDnsProviderUpdate `PATCH` body for a GCP DNS provider. Every field optional.
GcpDnsProviderUpdate = generated.GcpDnsProviderUpdate
// GcpDnsProviderUpdateDnsProviderName defines model for GcpDnsProviderUpdate.DnsProviderName.
GcpDnsProviderUpdateDnsProviderName = generated.GcpDnsProviderUpdateDnsProviderName
// GcpVmConfig `GET` response for a GCP VM provider config.
GcpVmConfig = generated.GcpVmConfig
// GcpVmConfigGcpCredentials0 defines model for GcpVmConfig.GcpCredentials.0.
GcpVmConfigGcpCredentials0 = generated.GcpVmConfigGcpCredentials0
// GcpVmConfigGcpCredentials1 defines model for GcpVmConfig.GcpCredentials.1.
GcpVmConfigGcpCredentials1 = generated.GcpVmConfigGcpCredentials1
// GcpVmConfig_GcpCredentials GCP service-account credentials, masked. `{}` if none are set.
GcpVmConfig_GcpCredentials = generated.GcpVmConfig_GcpCredentials
// GcpVmConfigVmProviderName defines model for GcpVmConfig.VmProviderName.
GcpVmConfigVmProviderName = generated.GcpVmConfigVmProviderName
// GcpVmConfigCreate `POST` body for a GCP VM provider config.
GcpVmConfigCreate = generated.GcpVmConfigCreate
// GcpVmConfigCreateVmProviderName defines model for GcpVmConfigCreate.VmProviderName.
GcpVmConfigCreateVmProviderName = generated.GcpVmConfigCreateVmProviderName
// GcpVmConfigUpdate `PATCH` body for a GCP VM provider config. Every field optional.
GcpVmConfigUpdate = generated.GcpVmConfigUpdate
// GcpVmConfigUpdateVmProviderName defines model for GcpVmConfigUpdate.VmProviderName.
GcpVmConfigUpdateVmProviderName = generated.GcpVmConfigUpdateVmProviderName
// GetRegistriesResponse Paginated registry list, plus the set of server architectures present
// in the deployment.
GetRegistriesResponse = generated.GetRegistriesResponse
// GetRegistriesResponseSortDirection defines model for GetRegistriesResponse.SortDirection.
GetRegistriesResponseSortDirection = generated.GetRegistriesResponseSortDirection
// GetUserImagesResponse Paginated list of the images available to the authenticated user.
// “all_categories“ spans every image the user can see, not just the
// current page, so category filters can be rendered without paging.
GetUserImagesResponse = generated.GetUserImagesResponse
// GetUserImagesResponseSortDirection defines model for GetUserImagesResponse.SortDirection.
GetUserImagesResponseSortDirection = generated.GetUserImagesResponseSortDirection
// GpuExclusions defines model for GpuExclusions.
GpuExclusions = generated.GpuExclusions
// GrantPermissionsRequest Body for granting additional permissions (POST).
//
// “permission_ids“ must be non-empty -- granting nothing is a meaningless
// request, unlike PUT (replace, “GroupPermissionsRequest“), which
// legitimately accepts an empty list to clear every existing grant.
GrantPermissionsRequest = generated.GrantPermissionsRequest
// GroupImageRef An image assigned to a group.
GroupImageRef = generated.GroupImageRef
// GroupMappingRef defines model for GroupMappingRef.
GroupMappingRef = generated.GroupMappingRef
// GroupPermissionsRequest Body for replacing a group's **or API config's** whole permission set (PUT).
//
// “permission_ids“ may be empty here -- this legitimately clears every
// existing grant. It has no default: the field must be present, so an
// omitted body or `{}` 422s rather than silently clearing every grant.
GroupPermissionsRequest = generated.GroupPermissionsRequest
// GroupSettingSummary A “group_settings“ row. “value“ is the stored string form (JSON-typed
// settings carry a JSON string), except “kasmvnc_mode_preference“, which is
// returned in its API form.
GroupSettingSummary = generated.GroupSettingSummary
// GroupSummary defines model for GroupSummary.
GroupSummary = generated.GroupSummary
// HTTPValidationError defines model for HTTPValidationError.
HTTPValidationError = generated.HTTPValidationError
// HarvesterVmConfig `GET` response for a Harvester VM provider config.
HarvesterVmConfig = generated.HarvesterVmConfig
// HarvesterVmConfigVmProviderName defines model for HarvesterVmConfig.VmProviderName.
HarvesterVmConfigVmProviderName = generated.HarvesterVmConfigVmProviderName
// HarvesterVmConfigCreate `POST` body for a Harvester VM provider config.
HarvesterVmConfigCreate = generated.HarvesterVmConfigCreate
// HarvesterVmConfigCreateVmProviderName defines model for HarvesterVmConfigCreate.VmProviderName.
HarvesterVmConfigCreateVmProviderName = generated.HarvesterVmConfigCreateVmProviderName
// HarvesterVmConfigUpdate `PATCH` body for a Harvester VM provider config. Every field optional.
HarvesterVmConfigUpdate = generated.HarvesterVmConfigUpdate
// HarvesterVmConfigUpdateVmProviderName defines model for HarvesterVmConfigUpdate.VmProviderName.
HarvesterVmConfigUpdateVmProviderName = generated.HarvesterVmConfigUpdateVmProviderName
// HelpLink “GET /api/platform/help-links/{doc_id}“ response.
//
// “fallback“ is “True“ when the upstream docs lookup failed and
// “url“ is a fallback link — this endpoint never 5xxs on that failure.
HelpLink = generated.HelpLink
// IMAGETYPE defines model for IMAGE_TYPE.
IMAGETYPE = generated.IMAGETYPE
// ImageAttributeSummary One custom attribute of an image, as returned inside “ImageSummary“.
ImageAttributeSummary = generated.ImageAttributeSummary
// ImageBannerRef The banner shown on an image's sessions, as returned in “ImageSummary.session_banner“.
ImageBannerRef = generated.ImageBannerRef
// ImageIncompatibleProblem Every host holding the image holds a build made for an older Kasm release
// than this backend supports.
ImageIncompatibleProblem = generated.ImageIncompatibleProblem
// ImageIncompatibleProblemType defines model for ImageIncompatibleProblem.Type.
ImageIncompatibleProblemType = generated.ImageIncompatibleProblemType
// ImageSummary One workspace image, with its assigned server or server pool.
ImageSummary = generated.ImageSummary
// ImageUpgradeCandidate Whether one image can move to a tag for the running Kasm release.
ImageUpgradeCandidate = generated.ImageUpgradeCandidate
// ImageUpgradeCandidateStatus `upgrade_available` when a workspace registry synced for the running release lists `to_name`'s tag; every other value explains why the image is left unchanged. `not_kasm_image` means no workspace registry lists the image's repository.
ImageUpgradeCandidateStatus = generated.ImageUpgradeCandidateStatus
// ImageUsageRow defines model for ImageUsageRow.
ImageUsageRow = generated.ImageUsageRow
// ImportAutoscaleConfigRef An AutoScale configuration carried by the uploaded export.
ImportAutoscaleConfigRef = generated.ImportAutoscaleConfigRef
// ImportErrorCode Machine-readable import failure codes. Values are stable identifiers
// clients may key on.
ImportErrorCode = generated.ImportErrorCode
// ImportLdapConfigRef An LDAP configuration referenced by the uploaded export.
ImportLdapConfigRef = generated.ImportLdapConfigRef
// ImportNameConflict A resource that will be renamed on import to resolve a name clash.
ImportNameConflict = generated.ImportNameConflict
// ImportProblemDetail problem+json body for an import failure, with a machine-readable “code“.
//
// “code“ is absent when the request body itself could not be parsed.
ImportProblemDetail = generated.ImportProblemDetail
// ImportProblemDetailType1 defines model for ImportProblemDetail.Type.1.
ImportProblemDetailType1 = generated.ImportProblemDetailType1
// ImportProblemDetail_Type defines model for ImportProblemDetail.Type.
ImportProblemDetail_Type = generated.ImportProblemDetail_Type
// ImportZoneRef A zone referenced by the uploaded export.
ImportZoneRef = generated.ImportZoneRef
// JobLogLine One log line a task body emitted.
JobLogLine = generated.JobLogLine
// JobLogPage A cursor-paginated page of job log lines.
JobLogPage = generated.JobLogPage
// JobStatusSummary One job_statuses row, as returned by the list endpoint.
//
// Each “*_id“ reference comes with a display name, which is “None“ once
// the referenced entity is gone: job_statuses keeps its references after
// sessions, servers and users are deleted.
JobStatusSummary = generated.JobStatusSummary
// JobStatusSummaryServerType defines model for JobStatusSummary.ServerType.
JobStatusSummaryServerType = generated.JobStatusSummaryServerType
// JoinSharedSessionResponse “POST /api/session/shares/{share_id}/participants“.
//
// A browser user gets the view and their access level. An API key holding
// “USERS_AUTH_SESSION“ is admitted as a new anonymous participant and
// additionally gets that identity's “user_id“, “username“, a login-session
// JWT (“session_token“), the browser hash route that redeems it
// (“connect_url“ = “/#/connect/join/{share_id}/{user_id}/{session_token}“)
// and “expires_at“, the earlier of the token's and the account's expiry.
JoinSharedSessionResponse = generated.JoinSharedSessionResponse
// JoinSharedSessionResponseAccess defines model for JoinSharedSessionResponse.Access.
JoinSharedSessionResponseAccess = generated.JoinSharedSessionResponseAccess
// KasmVncSettings “kasmvnc_settings“ — populated when “connection_type“ is
// “"KASMVNC"“.
KasmVncSettings = generated.KasmVncSettings
// KasmVncSettingsCreate “kasmvnc_settings“ on create.
//
// KasmVNC always logs a session in as a specific user, so both fields are
// required — same as “VncSettingsCreate“.
KasmVncSettingsCreate = generated.KasmVncSettingsCreate
// KasmVncSettingsUpdate “kasmvnc_settings“ on update — every field optional.
KasmVncSettingsUpdate = generated.KasmVncSettingsUpdate
// KeepaliveResponse “POST .../keepalives“.
//
// “usage_reached“ means the owner's usage allowance is exhausted and the
// expiration was *not* extended.
KeepaliveResponse = generated.KeepaliveResponse
// KubevirtVmConfig `GET` response for a KubeVirt VM provider config.
KubevirtVmConfig = generated.KubevirtVmConfig
// KubevirtVmConfigVmProviderName defines model for KubevirtVmConfig.VmProviderName.
KubevirtVmConfigVmProviderName = generated.KubevirtVmConfigVmProviderName
// KubevirtVmConfigCreate `POST` body for a KubeVirt VM provider config.
KubevirtVmConfigCreate = generated.KubevirtVmConfigCreate
// KubevirtVmConfigCreateVmProviderName defines model for KubevirtVmConfigCreate.VmProviderName.
KubevirtVmConfigCreateVmProviderName = generated.KubevirtVmConfigCreateVmProviderName
// KubevirtVmConfigUpdate `PATCH` body for a KubeVirt VM provider config. Every field optional.
KubevirtVmConfigUpdate = generated.KubevirtVmConfigUpdate
// KubevirtVmConfigUpdateVmProviderName defines model for KubevirtVmConfigUpdate.VmProviderName.
KubevirtVmConfigUpdateVmProviderName = generated.KubevirtVmConfigUpdateVmProviderName
// LOADSTRATEGY defines model for LOAD_STRATEGY.
LOADSTRATEGY = generated.LOADSTRATEGY
// LabelSummary One label, as returned by the list endpoint.
LabelSummary = generated.LabelSummary
// LabeledOption A “{label, value}“ pair for an in-memory lookup list (languages,
// timezones, and similar option lists).
LabeledOption = generated.LabeledOption
// LastEnabledConnectionProxyProblem Disabling this proxy would leave sessions without an enabled proxy of its
// type in its zone. Nothing was changed; resend with “force“ (and optionally
// “stop_sessions“) to proceed.
LastEnabledConnectionProxyProblem = generated.LastEnabledConnectionProxyProblem
// LastEnabledConnectionProxyProblemType defines model for LastEnabledConnectionProxyProblem.Type.
LastEnabledConnectionProxyProblemType = generated.LastEnabledConnectionProxyProblemType
// LaunchConfigRequiredProblem The image has a launch form and the request did not satisfy it.
LaunchConfigRequiredProblem = generated.LaunchConfigRequiredProblem
// LaunchConfigRequiredProblemType defines model for LaunchConfigRequiredProblem.Type.
LaunchConfigRequiredProblemType = generated.LaunchConfigRequiredProblemType
// LaunchOptions What a client needs to render the launch dialog for an image.
//
// Carried as the “extensions“ of the “launch-config-required“,
// “rdp-client-required“ and “egress-selection-required“ problems from
// “POST /api/session/sessions“ and “POST /api/session/cast-links/{key}/claims“, and
// embedded in “GET /api/session/cast-links/{key}“ so a cast visitor sees the form
// up front. “launch_config“ is the image's own form definition, opaque here.
LaunchOptions = generated.LaunchOptions
// LdapConfigSummary One LDAP/AD auth-provider config (an “ldap_configs“ row).
//
// “service_account_password“ is always masked in responses; echoing the
// masked value back on update leaves it unchanged. “connection_timeout“ is
// accepted on create and never serialized.
LdapConfigSummary = generated.LdapConfigSummary
// LdapTestResult Outcome of a directory login test (one shape for pass and fail — the
// test *ran* either way; “success“ carries the verdict).
LdapTestResult = generated.LdapTestResult
// LicenseStatus Deployment entitlement as shown to a standard user.
//
// Deliberately has no `egress_plugins` field: standard users must not see
// per-plugin seat detail.
LicenseStatus = generated.LicenseStatus
// LicenseSummary A license as the admin API returns it.
//
// Most fields are read from the license key itself, so nearly every field is optional: a key
// that cannot be decoded, or an older key that lacks a field, leaves it null.
LicenseSummary = generated.LicenseSummary
// LifecycleCommand defines model for LifecycleCommand.
LifecycleCommand = generated.LifecycleCommand
// LifecycleCommandRequest “POST .../lifecycle-commands“: change the session's desired state.
LifecycleCommandRequest = generated.LifecycleCommandRequest
// LogExportRequest “POST /api/admin/platform/logs/exports“ request body.
//
// “export_password“ is accepted only in the body. Missing dates are a 422.
LogExportRequest = generated.LogExportRequest
// LogFacets defines model for LogFacets.
LogFacets = generated.LogFacets
// LogRecord One log search result, including trace, span, service and severity.
LogRecord = generated.LogRecord
// LoginRequest Body for “POST /api/auth/login“.
LoginRequest = generated.LoginRequest
// LoginSettingsOidcConfig One OIDC provider offered on the login page.
LoginSettingsOidcConfig = generated.LoginSettingsOidcConfig
// LoginSettingsRecaptcha The captcha the login page must solve, if the deployment configured one.
//
// “captcha_selection“ is only meaningful once a site key is configured.
LoginSettingsRecaptcha = generated.LoginSettingsRecaptcha
// LoginSettingsResponse Everything the login page renders itself from, for one hostname.
//
// Unauthenticated and identical for every caller on that hostname, so the
// service caches it briefly; the branding fields fall back to the built-in
// Kasm branding when the deployment is not licensed for its own.
LoginSettingsResponse = generated.LoginSettingsResponse
// LoginSettingsSamlConfig One SAML provider offered on the login page.
LoginSettingsSamlConfig = generated.LoginSettingsSamlConfig
// LoginsTimeSeries defines model for LoginsTimeSeries.
LoginsTimeSeries = generated.LoginsTimeSeries
// LogoutRequest Body for “POST /api/auth/logout“.
//
// “saml_id“/“oidc_id“ name the identity provider the caller signed in
// through, so the response can carry that provider's single-logout URL.
LogoutRequest = generated.LogoutRequest
// LogoutResponse Where to send the browser next after a logout.
//
// “slo_url“ is populated only for an SSO session whose provider is
// configured for single logout; the Kasm session is already revoked either
// way.
LogoutResponse = generated.LogoutResponse
// LogsPayload defines model for LogsPayload.
LogsPayload = generated.LogsPayload
// MetricsCatalogEntry One row from “DataAccess.component_to_dict“.
MetricsCatalogEntry = generated.MetricsCatalogEntry
// MetricsCatalogGroup A parent catalog component plus its children.
MetricsCatalogGroup = generated.MetricsCatalogGroup
// MetricsPayload defines model for MetricsPayload.
MetricsPayload = generated.MetricsPayload
// ModePreference “kasmvnc_mode_preference“ client setting: every codec the deployment supports
// (“available“) and the caller's selection in priority order (“active“).
ModePreference = generated.ModePreference
// ModePreferenceOption One entry in “ModePreference.available“/“.active“ — an encoder/
// quality profile id + display label.
//
// “id“ is the codec's integer id (“KASMVNC_MODE_CODECS.codec_id“), not
// a string -- despite the "id" name pattern used elsewhere in this module
// for UUID path params. “family“/“kasmvnc_codec_name“ are only present
// on “available“ entries: “KASMVNC_MODE_CODECS.as_dict()“ includes them,
// but “active“ entries are rebuilt by
// “mode_preference.normalize_mode_preference_active_list“ from just
// “{id, label}“, so they're optional here.
ModePreferenceOption = generated.ModePreferenceOption
// MySessionsResponse “GET /api/session/sessions“.
MySessionsResponse = generated.MySessionsResponse
// NetworkPolicyDirection defines model for NetworkPolicyDirection.
NetworkPolicyDirection = generated.NetworkPolicyDirection
// NetworkPolicyDirectionDefaultAction defines model for NetworkPolicyDirection.DefaultAction.
NetworkPolicyDirectionDefaultAction = generated.NetworkPolicyDirectionDefaultAction
// NetworkPolicyDirectionRequest defines model for NetworkPolicyDirectionRequest.
NetworkPolicyDirectionRequest = generated.NetworkPolicyDirectionRequest
// NetworkPolicyDirectionRequestDefaultAction defines model for NetworkPolicyDirectionRequest.DefaultAction.
NetworkPolicyDirectionRequestDefaultAction = generated.NetworkPolicyDirectionRequestDefaultAction
// NetworkPolicySummary One stored network policy.
NetworkPolicySummary = generated.NetworkPolicySummary
// NetworkRef Inline Docker network reference returned in user-facing image listings.
//
// Docker networks are runtime constructs with no Kasm ORM row, so this ref
// has no domain owner and lives in “common“.
NetworkRef = generated.NetworkRef
// NetworkRule One network policy rule.
NetworkRule = generated.NetworkRule
// NetworkRuleAction defines model for NetworkRule.Action.
NetworkRuleAction = generated.NetworkRuleAction
// NetworkRuleProtocol defines model for NetworkRule.Protocol.
NetworkRuleProtocol = generated.NetworkRuleProtocol
// NetworkRuleAddress defines model for NetworkRuleAddress.
NetworkRuleAddress = generated.NetworkRuleAddress
// NetworkRuleAddressKind defines model for NetworkRuleAddress.Kind.
NetworkRuleAddressKind = generated.NetworkRuleAddressKind
// NoResourcesProblem No server or agent can take the session right now. “reason“ names the
// refusing server or the missing capacity and is included only for an
// administrator; ordinary users get the generic “detail“ alone.
NoResourcesProblem = generated.NoResourcesProblem
// NoResourcesProblemType defines model for NoResourcesProblem.Type.
NoResourcesProblemType = generated.NoResourcesProblemType
// NutanixVmConfig `GET` response for a Nutanix VM provider config.
NutanixVmConfig = generated.NutanixVmConfig
// NutanixVmConfigDeploymentType How Kasm creates new autoscaled VMs: clone copies the VM named by vm_candidate; template deploys the active version of the Nutanix template named by vm_candidate (requires api_version v4).
NutanixVmConfigDeploymentType = generated.NutanixVmConfigDeploymentType
// NutanixVmConfigVmProviderName defines model for NutanixVmConfig.VmProviderName.
NutanixVmConfigVmProviderName = generated.NutanixVmConfigVmProviderName
// NutanixVmConfigCreate `POST` body for a Nutanix VM provider config.
NutanixVmConfigCreate = generated.NutanixVmConfigCreate
// NutanixVmConfigCreateDeploymentType How Kasm creates new autoscaled VMs: clone copies the VM named by vm_candidate; template deploys the active version of the Nutanix template named by vm_candidate (requires api_version v4).
NutanixVmConfigCreateDeploymentType = generated.NutanixVmConfigCreateDeploymentType
// NutanixVmConfigCreateVmProviderName defines model for NutanixVmConfigCreate.VmProviderName.
NutanixVmConfigCreateVmProviderName = generated.NutanixVmConfigCreateVmProviderName
// NutanixVmConfigUpdate `PATCH` body for a Nutanix VM provider config. Every field optional.
NutanixVmConfigUpdate = generated.NutanixVmConfigUpdate
// NutanixVmConfigUpdateDeploymentType How Kasm creates new autoscaled VMs: clone copies the VM named by vm_candidate; template deploys the active version of the Nutanix template named by vm_candidate (requires api_version v4).
NutanixVmConfigUpdateDeploymentType = generated.NutanixVmConfigUpdateDeploymentType
// NutanixVmConfigUpdateVmProviderName defines model for NutanixVmConfigUpdate.VmProviderName.
NutanixVmConfigUpdateVmProviderName = generated.NutanixVmConfigUpdateVmProviderName
// OciDnsProvider `GET` response for an OCI DNS provider.
OciDnsProvider = generated.OciDnsProvider
// OciDnsProviderDnsProviderName defines model for OciDnsProvider.DnsProviderName.
OciDnsProviderDnsProviderName = generated.OciDnsProviderDnsProviderName
// OciDnsProviderCreate `POST` body for an OCI DNS provider.
OciDnsProviderCreate = generated.OciDnsProviderCreate
// OciDnsProviderCreateDnsProviderName defines model for OciDnsProviderCreate.DnsProviderName.
OciDnsProviderCreateDnsProviderName = generated.OciDnsProviderCreateDnsProviderName
// OciDnsProviderUpdate `PATCH` body for an OCI DNS provider. Every field optional.
OciDnsProviderUpdate = generated.OciDnsProviderUpdate
// OciDnsProviderUpdateDnsProviderName defines model for OciDnsProviderUpdate.DnsProviderName.
OciDnsProviderUpdateDnsProviderName = generated.OciDnsProviderUpdateDnsProviderName
// OciVmConfig `GET` response for an OCI VM provider config.
OciVmConfig = generated.OciVmConfig
// OciVmConfigVmProviderName defines model for OciVmConfig.VmProviderName.
OciVmConfigVmProviderName = generated.OciVmConfigVmProviderName
// OciVmConfigCreate `POST` body for an OCI VM provider config.
OciVmConfigCreate = generated.OciVmConfigCreate
// OciVmConfigCreateVmProviderName defines model for OciVmConfigCreate.VmProviderName.
OciVmConfigCreateVmProviderName = generated.OciVmConfigCreateVmProviderName
// OciVmConfigUpdate `PATCH` body for an OCI VM provider config. Every field optional.
OciVmConfigUpdate = generated.OciVmConfigUpdate
// OciVmConfigUpdateVmProviderName defines model for OciVmConfigUpdate.VmProviderName.
OciVmConfigUpdateVmProviderName = generated.OciVmConfigUpdateVmProviderName
// OidcConfigSummary One OpenID Connect auth-provider config (an “oidc_configs“ row).
//
// “client_secret“ is always masked in responses; echoing the masked value
// back on update leaves it unchanged.
OidcConfigSummary = generated.OidcConfigSummary
// OpenstackVmConfig `GET` response for an OpenStack VM provider config.
OpenstackVmConfig = generated.OpenstackVmConfig
// OpenstackVmConfigVmProviderName defines model for OpenstackVmConfig.VmProviderName.
OpenstackVmConfigVmProviderName = generated.OpenstackVmConfigVmProviderName
// OpenstackVmConfigCreate `POST` body for an OpenStack VM provider config.
OpenstackVmConfigCreate = generated.OpenstackVmConfigCreate
// OpenstackVmConfigCreateVmProviderName defines model for OpenstackVmConfigCreate.VmProviderName.
OpenstackVmConfigCreateVmProviderName = generated.OpenstackVmConfigCreateVmProviderName
// OpenstackVmConfigUpdate `PATCH` body for an OpenStack VM provider config. Every field optional.
OpenstackVmConfigUpdate = generated.OpenstackVmConfigUpdate
// OpenstackVmConfigUpdateVmProviderName defines model for OpenstackVmConfigUpdate.VmProviderName.
OpenstackVmConfigUpdateVmProviderName = generated.OpenstackVmConfigUpdateVmProviderName
// OtlpAttribute defines model for OtlpAttribute.
OtlpAttribute = generated.OtlpAttribute
// OtlpDataPoint defines model for OtlpDataPoint.
OtlpDataPoint = generated.OtlpDataPoint
// OtlpDataPoints Container for one metric data kind (“gauge“ / “sum“ / “histogram“).
OtlpDataPoints = generated.OtlpDataPoints
// OtlpLogRecord defines model for OtlpLogRecord.
OtlpLogRecord = generated.OtlpLogRecord
// OtlpMetric defines model for OtlpMetric.
OtlpMetric = generated.OtlpMetric
// OtlpResource defines model for OtlpResource.
OtlpResource = generated.OtlpResource
// OtlpResourceLogs defines model for OtlpResourceLogs.
OtlpResourceLogs = generated.OtlpResourceLogs
// OtlpResourceMetrics defines model for OtlpResourceMetrics.
OtlpResourceMetrics = generated.OtlpResourceMetrics
// OtlpResourceSpans defines model for OtlpResourceSpans.
OtlpResourceSpans = generated.OtlpResourceSpans
// OtlpScopeLogs defines model for OtlpScopeLogs.
OtlpScopeLogs = generated.OtlpScopeLogs
// OtlpScopeMetrics defines model for OtlpScopeMetrics.
OtlpScopeMetrics = generated.OtlpScopeMetrics
// OtlpScopeSpans defines model for OtlpScopeSpans.
OtlpScopeSpans = generated.OtlpScopeSpans
// OtlpSpan defines model for OtlpSpan.
OtlpSpan = generated.OtlpSpan
// OtlpSpanEvent defines model for OtlpSpanEvent.
OtlpSpanEvent = generated.OtlpSpanEvent
// OtlpSpanLink defines model for OtlpSpanLink.
OtlpSpanLink = generated.OtlpSpanLink
// OtlpSpanStatus defines model for OtlpSpanStatus.
OtlpSpanStatus = generated.OtlpSpanStatus
// PagedResponseAccountingSummary defines model for PagedResponse_AccountingSummary_.
PagedResponseAccountingSummary = generated.PagedResponseAccountingSummary