@homeflare/distilled-proxmox 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +87 -0
  3. package/dist/credentials.d.ts +41 -0
  4. package/dist/credentials.d.ts.map +1 -0
  5. package/dist/credentials.js +67 -0
  6. package/dist/credentials.js.map +1 -0
  7. package/dist/errors.d.ts +128 -0
  8. package/dist/errors.d.ts.map +1 -0
  9. package/dist/errors.js +91 -0
  10. package/dist/errors.js.map +1 -0
  11. package/dist/index.d.ts +30 -0
  12. package/dist/index.d.ts.map +1 -0
  13. package/dist/index.js +30 -0
  14. package/dist/index.js.map +1 -0
  15. package/dist/protocol.d.ts +18 -0
  16. package/dist/protocol.d.ts.map +1 -0
  17. package/dist/protocol.js +167 -0
  18. package/dist/protocol.js.map +1 -0
  19. package/dist/protocol.test.d.ts +2 -0
  20. package/dist/protocol.test.d.ts.map +1 -0
  21. package/dist/protocol.test.js +64 -0
  22. package/dist/protocol.test.js.map +1 -0
  23. package/dist/retry.d.ts +50 -0
  24. package/dist/retry.d.ts.map +1 -0
  25. package/dist/retry.js +43 -0
  26. package/dist/retry.js.map +1 -0
  27. package/dist/services/access.d.ts +975 -0
  28. package/dist/services/access.d.ts.map +1 -0
  29. package/dist/services/access.js +1208 -0
  30. package/dist/services/access.js.map +1 -0
  31. package/dist/services/cluster.d.ts +5940 -0
  32. package/dist/services/cluster.d.ts.map +1 -0
  33. package/dist/services/cluster.js +7405 -0
  34. package/dist/services/cluster.js.map +1 -0
  35. package/dist/services/index.d.ts +7 -0
  36. package/dist/services/index.d.ts.map +1 -0
  37. package/dist/services/index.js +8 -0
  38. package/dist/services/index.js.map +1 -0
  39. package/dist/services/nodes.d.ts +7887 -0
  40. package/dist/services/nodes.d.ts.map +1 -0
  41. package/dist/services/nodes.js +10253 -0
  42. package/dist/services/nodes.js.map +1 -0
  43. package/dist/services/pools.d.ts +133 -0
  44. package/dist/services/pools.d.ts.map +1 -0
  45. package/dist/services/pools.js +183 -0
  46. package/dist/services/pools.js.map +1 -0
  47. package/dist/services/storage.d.ts +317 -0
  48. package/dist/services/storage.d.ts.map +1 -0
  49. package/dist/services/storage.js +239 -0
  50. package/dist/services/storage.js.map +1 -0
  51. package/dist/services/version.d.ts +20 -0
  52. package/dist/services/version.d.ts.map +1 -0
  53. package/dist/services/version.js +27 -0
  54. package/dist/services/version.js.map +1 -0
  55. package/dist/task.d.ts +51 -0
  56. package/dist/task.d.ts.map +1 -0
  57. package/dist/task.js +60 -0
  58. package/dist/task.js.map +1 -0
  59. package/dist/traits.d.ts +12 -0
  60. package/dist/traits.d.ts.map +1 -0
  61. package/dist/traits.js +14 -0
  62. package/dist/traits.js.map +1 -0
  63. package/package.json +81 -0
  64. package/src/credentials.ts +101 -0
  65. package/src/errors.ts +152 -0
  66. package/src/index.ts +33 -0
  67. package/src/protocol.test.ts +101 -0
  68. package/src/protocol.ts +204 -0
  69. package/src/retry.ts +74 -0
  70. package/src/services/access.ts +2722 -0
  71. package/src/services/cluster.ts +18550 -0
  72. package/src/services/index.ts +7 -0
  73. package/src/services/nodes.ts +25537 -0
  74. package/src/services/pools.ts +397 -0
  75. package/src/services/storage.ts +711 -0
  76. package/src/services/version.ts +54 -0
  77. package/src/task.ts +87 -0
  78. package/src/traits.ts +45 -0
@@ -0,0 +1,975 @@
1
+ import * as S from "@distilled.cloud/core/schema";
2
+ import * as API from "@distilled.cloud/core/api";
3
+ import { type ProxmoxOpError, type ProxmoxOpContext } from "../protocol.ts";
4
+ export type { ProxmoxOpError, ProxmoxOpContext };
5
+ export type CreateAccessDomainRequestMode = "ldap" | "ldaps" | "ldap+starttls";
6
+ export declare const CreateAccessDomainRequestMode: any;
7
+ export type CreateAccessDomainRequestSslversion = "tlsv1" | "tlsv1_1" | "tlsv1_2" | "tlsv1_3";
8
+ export declare const CreateAccessDomainRequestSslversion: any;
9
+ export type CreateAccessDomainRequestType = "ad" | "ldap" | "openid" | "pam" | "pve";
10
+ export declare const CreateAccessDomainRequestType: any;
11
+ export interface CreateAccessDomainRequest {
12
+ /** Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. */
13
+ acr_values?: string;
14
+ /** A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. */
15
+ audiences?: string;
16
+ /** Automatically create users if they do not exist. */
17
+ autocreate?: string;
18
+ /** LDAP base domain name */
19
+ base_dn?: string;
20
+ /** LDAP bind domain name */
21
+ bind_dn?: string;
22
+ /** Path to the CA certificate store */
23
+ capath?: string;
24
+ /** username is case-sensitive */
25
+ case_sensitive?: string;
26
+ /** Path to the client certificate */
27
+ cert?: string;
28
+ /** Path to the client certificate key */
29
+ certkey?: string;
30
+ /** Check bind connection to the server. */
31
+ check_connection?: string;
32
+ /** OpenID Client ID */
33
+ client_id?: string;
34
+ /** OpenID Client Key */
35
+ client_key?: string;
36
+ /** Description. */
37
+ comment?: string;
38
+ /** Use this as default realm */
39
+ default?: string;
40
+ /** AD domain name */
41
+ domain?: string;
42
+ /** LDAP filter for user sync. */
43
+ filter?: string;
44
+ /** The objectclasses for groups. */
45
+ group_classes?: string;
46
+ /** LDAP base domain name for group sync. If not set, the base_dn will be used. */
47
+ group_dn?: string;
48
+ /** LDAP filter for group sync. */
49
+ group_filter?: string;
50
+ /** LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. */
51
+ group_name_attr?: string;
52
+ /** Automatically create groups if they do not exist. */
53
+ groups_autocreate?: string;
54
+ /** OpenID claim used to retrieve groups with. */
55
+ groups_claim?: string;
56
+ /** All groups will be overwritten for the user on login. */
57
+ groups_overwrite?: string;
58
+ /** OpenID Issuer Url */
59
+ issuer_url?: string;
60
+ /** LDAP protocol mode. */
61
+ mode?: CreateAccessDomainRequestMode | (string & {});
62
+ /** LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. */
63
+ password?: string;
64
+ /** Server port. */
65
+ port?: string;
66
+ /** Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. */
67
+ prompt?: string;
68
+ /** Enables querying the userinfo endpoint for claims values. */
69
+ query_userinfo?: string;
70
+ /** Authentication domain ID */
71
+ realm: string;
72
+ /** Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. */
73
+ scopes?: string;
74
+ /** Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. */
75
+ secure?: string;
76
+ /** Server IP address (or DNS name) */
77
+ server1?: string;
78
+ /** Fallback Server IP address (or DNS name) */
79
+ server2?: string;
80
+ /** LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! */
81
+ sslversion?: CreateAccessDomainRequestSslversion | (string & {});
82
+ /** The default options for behavior of synchronizations. */
83
+ sync_defaults_options?: string;
84
+ /** Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. */
85
+ sync_attributes?: string;
86
+ /** Use Two-factor authentication. */
87
+ tfa?: string;
88
+ /** Realm type. */
89
+ type: CreateAccessDomainRequestType | (string & {});
90
+ /** LDAP user attribute name */
91
+ user_attr?: string;
92
+ /** The objectclasses for users. */
93
+ user_classes?: string;
94
+ /** OpenID claim used to generate the unique username. */
95
+ username_claim?: string;
96
+ /** Verify the server's SSL certificate */
97
+ verify?: string;
98
+ }
99
+ export declare const CreateAccessDomainRequest: S.Schema<CreateAccessDomainRequest>;
100
+ export interface CreateAccessDomainResponse {
101
+ }
102
+ export declare const CreateAccessDomainResponse: S.Schema<CreateAccessDomainResponse>;
103
+ export interface CreateAccessGroupRequest {
104
+ comment?: string;
105
+ groupid: string;
106
+ }
107
+ export declare const CreateAccessGroupRequest: S.Schema<CreateAccessGroupRequest>;
108
+ export interface CreateAccessGroupResponse {
109
+ }
110
+ export declare const CreateAccessGroupResponse: S.Schema<CreateAccessGroupResponse>;
111
+ export interface CreateAccessOpenidAuthUrlRequest {
112
+ /** Authentication domain ID */
113
+ realm: string;
114
+ /** Redirection Url. The client should set this to the used server url (location.origin). */
115
+ redirect_url: string;
116
+ }
117
+ export declare const CreateAccessOpenidAuthUrlRequest: S.Schema<CreateAccessOpenidAuthUrlRequest>;
118
+ export type CreateAccessOpenidAuthUrlResponse = string;
119
+ export declare const CreateAccessOpenidAuthUrlResponse: S.Schema<CreateAccessOpenidAuthUrlResponse>;
120
+ export interface CreateAccessRoleRequest {
121
+ privs?: string;
122
+ roleid: string;
123
+ }
124
+ export declare const CreateAccessRoleRequest: S.Schema<CreateAccessRoleRequest>;
125
+ export interface CreateAccessRoleResponse {
126
+ }
127
+ export declare const CreateAccessRoleResponse: S.Schema<CreateAccessRoleResponse>;
128
+ export interface CreateAccessTicketRequest {
129
+ /** This parameter is now ignored and assumed to be 1. */
130
+ new_format?: string;
131
+ /** One-time password for Two-factor authentication. */
132
+ otp?: string;
133
+ /** The secret password. This can also be a valid ticket. */
134
+ password: string;
135
+ /** Verify ticket, and check if user have access 'privs' on 'path' */
136
+ path?: string;
137
+ /** Verify ticket, and check if user have access 'privs' on 'path' */
138
+ privs?: string;
139
+ /** You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<realm>. */
140
+ realm?: string;
141
+ /** The signed TFA challenge string the user wants to respond to. */
142
+ tfa_challenge?: string;
143
+ /** User name */
144
+ username: string;
145
+ }
146
+ export declare const CreateAccessTicketRequest: S.Schema<CreateAccessTicketRequest>;
147
+ export interface CreateAccessTicketResponse {
148
+ CSRFPreventionToken?: string;
149
+ clustername?: string;
150
+ ticket?: string;
151
+ username: string;
152
+ }
153
+ export declare const CreateAccessTicketResponse: S.Schema<CreateAccessTicketResponse>;
154
+ export interface CreateAccessUserRequest {
155
+ comment?: string;
156
+ email?: string;
157
+ /** Enable the account (default). You can set this to '0' to disable the account */
158
+ enable?: string;
159
+ /** Account expiration date (seconds since epoch). '0' means no expiration date. */
160
+ expire?: string;
161
+ firstname?: string;
162
+ groups?: string;
163
+ /** Keys for two factor auth (yubico). */
164
+ keys?: string;
165
+ lastname?: string;
166
+ /** Initial password. */
167
+ password?: string;
168
+ /** Full User ID, in the `name@realm` format. */
169
+ userid: string;
170
+ }
171
+ export declare const CreateAccessUserRequest: S.Schema<CreateAccessUserRequest>;
172
+ export interface CreateAccessUserResponse {
173
+ }
174
+ export declare const CreateAccessUserResponse: S.Schema<CreateAccessUserResponse>;
175
+ export interface CreateAccessVncticketRequest {
176
+ /** UserId or token */
177
+ authid: string;
178
+ /** Verify ticket, and check if user have access 'privs' on 'path' */
179
+ path: string;
180
+ /** Verify that the ticket is valid for this port. */
181
+ port?: string;
182
+ /** Verify ticket, and check if user have access 'privs' on 'path' */
183
+ privs: string;
184
+ /** The VNC ticket. */
185
+ vncticket: string;
186
+ }
187
+ export declare const CreateAccessVncticketRequest: S.Schema<CreateAccessVncticketRequest>;
188
+ export interface CreateAccessVncticketResponse {
189
+ }
190
+ export declare const CreateAccessVncticketResponse: S.Schema<CreateAccessVncticketResponse>;
191
+ export interface DeleteAccessDomainRequest {
192
+ realm: string;
193
+ }
194
+ export declare const DeleteAccessDomainRequest: S.Schema<DeleteAccessDomainRequest>;
195
+ export interface DeleteAccessDomainResponse {
196
+ }
197
+ export declare const DeleteAccessDomainResponse: S.Schema<DeleteAccessDomainResponse>;
198
+ export interface DeleteAccessGroupRequest {
199
+ groupid: string;
200
+ }
201
+ export declare const DeleteAccessGroupRequest: S.Schema<DeleteAccessGroupRequest>;
202
+ export interface DeleteAccessGroupResponse {
203
+ }
204
+ export declare const DeleteAccessGroupResponse: S.Schema<DeleteAccessGroupResponse>;
205
+ export interface DeleteAccessRoleRequest {
206
+ roleid: string;
207
+ }
208
+ export declare const DeleteAccessRoleRequest: S.Schema<DeleteAccessRoleRequest>;
209
+ export interface DeleteAccessRoleResponse {
210
+ }
211
+ export declare const DeleteAccessRoleResponse: S.Schema<DeleteAccessRoleResponse>;
212
+ export interface DeleteAccessTfaRequest {
213
+ userid: string;
214
+ id: string;
215
+ /** The current password of the user performing the change. */
216
+ password?: string;
217
+ }
218
+ export declare const DeleteAccessTfaRequest: S.Schema<DeleteAccessTfaRequest>;
219
+ export interface DeleteAccessTfaResponse {
220
+ }
221
+ export declare const DeleteAccessTfaResponse: S.Schema<DeleteAccessTfaResponse>;
222
+ export interface DeleteAccessUserRequest {
223
+ userid: string;
224
+ }
225
+ export declare const DeleteAccessUserRequest: S.Schema<DeleteAccessUserRequest>;
226
+ export interface DeleteAccessUserResponse {
227
+ }
228
+ export declare const DeleteAccessUserResponse: S.Schema<DeleteAccessUserResponse>;
229
+ export interface DeleteAccessUserTokenRequest {
230
+ userid: string;
231
+ tokenid: string;
232
+ }
233
+ export declare const DeleteAccessUserTokenRequest: S.Schema<DeleteAccessUserTokenRequest>;
234
+ export interface DeleteAccessUserTokenResponse {
235
+ }
236
+ export declare const DeleteAccessUserTokenResponse: S.Schema<DeleteAccessUserTokenResponse>;
237
+ export interface GetAccessDomainRequest {
238
+ realm: string;
239
+ }
240
+ export declare const GetAccessDomainRequest: S.Schema<GetAccessDomainRequest>;
241
+ export type GetAccessDomainResponse = unknown;
242
+ export declare const GetAccessDomainResponse: S.Schema<GetAccessDomainResponse>;
243
+ export interface GetAccessGroupRequest {
244
+ groupid: string;
245
+ }
246
+ export declare const GetAccessGroupRequest: S.Schema<GetAccessGroupRequest>;
247
+ export type GetAccessGroupResponseMembersList = Array<string>;
248
+ export declare const GetAccessGroupResponseMembersList: S.Schema<GetAccessGroupResponseMembersList>;
249
+ export interface GetAccessGroupResponse {
250
+ comment?: string;
251
+ members: GetAccessGroupResponseMembersList;
252
+ }
253
+ export declare const GetAccessGroupResponse: S.Schema<GetAccessGroupResponse>;
254
+ export interface GetAccessPermissionsRequest {
255
+ /** Only dump this specific path, not the whole tree. */
256
+ path?: string;
257
+ /** User ID or full API token ID */
258
+ userid?: string;
259
+ }
260
+ export declare const GetAccessPermissionsRequest: S.Schema<GetAccessPermissionsRequest>;
261
+ export type GetAccessPermissionsResponse = unknown;
262
+ export declare const GetAccessPermissionsResponse: S.Schema<GetAccessPermissionsResponse>;
263
+ export interface GetAccessRoleRequest {
264
+ roleid: string;
265
+ }
266
+ export declare const GetAccessRoleRequest: S.Schema<GetAccessRoleRequest>;
267
+ export interface GetAccessRoleResponse {
268
+ Datastore_Allocate?: unknown;
269
+ Datastore_AllocateSpace?: unknown;
270
+ Datastore_AllocateTemplate?: unknown;
271
+ Datastore_Audit?: unknown;
272
+ Group_Allocate?: unknown;
273
+ Mapping_Audit?: unknown;
274
+ Mapping_Modify?: unknown;
275
+ Mapping_Use?: unknown;
276
+ Permissions_Modify?: unknown;
277
+ Pool_Allocate?: unknown;
278
+ Pool_Audit?: unknown;
279
+ Realm_Allocate?: unknown;
280
+ Realm_AllocateUser?: unknown;
281
+ SDN_Allocate?: unknown;
282
+ SDN_Audit?: unknown;
283
+ SDN_Use?: unknown;
284
+ Sys_AccessNetwork?: unknown;
285
+ Sys_Audit?: unknown;
286
+ Sys_Console?: unknown;
287
+ Sys_Incoming?: unknown;
288
+ Sys_Modify?: unknown;
289
+ Sys_PowerMgmt?: unknown;
290
+ Sys_Syslog?: unknown;
291
+ User_Modify?: unknown;
292
+ VM_Allocate?: unknown;
293
+ VM_Audit?: unknown;
294
+ VM_Backup?: unknown;
295
+ VM_Clone?: unknown;
296
+ VM_Config_CDROM?: unknown;
297
+ VM_Config_CPU?: unknown;
298
+ VM_Config_Cloudinit?: unknown;
299
+ VM_Config_Disk?: unknown;
300
+ VM_Config_HWType?: unknown;
301
+ VM_Config_Memory?: unknown;
302
+ VM_Config_Network?: unknown;
303
+ VM_Config_Options?: unknown;
304
+ VM_Console?: unknown;
305
+ VM_GuestAgent_Audit?: unknown;
306
+ VM_GuestAgent_FileRead?: unknown;
307
+ VM_GuestAgent_FileSystemMgmt?: unknown;
308
+ VM_GuestAgent_FileWrite?: unknown;
309
+ VM_GuestAgent_Unrestricted?: unknown;
310
+ VM_Migrate?: unknown;
311
+ VM_PowerMgmt?: unknown;
312
+ VM_Replicate?: unknown;
313
+ VM_Snapshot?: unknown;
314
+ VM_Snapshot_Rollback?: unknown;
315
+ }
316
+ export declare const GetAccessRoleResponse: S.Schema<GetAccessRoleResponse>;
317
+ export interface GetAccessTfaRequest {
318
+ userid: string;
319
+ }
320
+ export declare const GetAccessTfaRequest: S.Schema<GetAccessTfaRequest>;
321
+ export type GetAccessTfaResponseBodyItemType = "totp" | "u2f" | "webauthn" | "recovery" | "yubico";
322
+ export declare const GetAccessTfaResponseBodyItemType: any;
323
+ export interface GetAccessTfaResponseBodyItem {
324
+ created: number;
325
+ description: string;
326
+ enable?: unknown;
327
+ id: string;
328
+ type: GetAccessTfaResponseBodyItemType;
329
+ }
330
+ export declare const GetAccessTfaResponseBodyItem: S.Schema<GetAccessTfaResponseBodyItem>;
331
+ export type GetAccessTfaResponseBodyList = Array<GetAccessTfaResponseBodyItem>;
332
+ export declare const GetAccessTfaResponseBodyList: S.Schema<GetAccessTfaResponseBodyList>;
333
+ export type GetAccessTfaResponse = GetAccessTfaResponseBodyList;
334
+ export declare const GetAccessTfaResponse: S.Schema<GetAccessTfaResponse>;
335
+ export interface GetAccessTfa2Request {
336
+ userid: string;
337
+ id: string;
338
+ }
339
+ export declare const GetAccessTfa2Request: S.Schema<GetAccessTfa2Request>;
340
+ export type GetAccessTfa2ResponseType = "totp" | "u2f" | "webauthn" | "recovery" | "yubico";
341
+ export declare const GetAccessTfa2ResponseType: any;
342
+ export interface GetAccessTfa2Response {
343
+ created: number;
344
+ description: string;
345
+ enable?: unknown;
346
+ id: string;
347
+ type: GetAccessTfa2ResponseType;
348
+ }
349
+ export declare const GetAccessTfa2Response: S.Schema<GetAccessTfa2Response>;
350
+ export interface GetAccessTicketRequest {
351
+ }
352
+ export declare const GetAccessTicketRequest: S.Schema<GetAccessTicketRequest>;
353
+ export interface GetAccessTicketResponse {
354
+ }
355
+ export declare const GetAccessTicketResponse: S.Schema<GetAccessTicketResponse>;
356
+ export interface GetAccessUserRequest {
357
+ userid: string;
358
+ }
359
+ export declare const GetAccessUserRequest: S.Schema<GetAccessUserRequest>;
360
+ export type GetAccessUserResponseGroupsList = Array<string>;
361
+ export declare const GetAccessUserResponseGroupsList: S.Schema<GetAccessUserResponseGroupsList>;
362
+ export interface GetAccessUserResponse {
363
+ comment?: string;
364
+ email?: string;
365
+ enable?: unknown;
366
+ expire?: number;
367
+ firstname?: string;
368
+ groups?: GetAccessUserResponseGroupsList;
369
+ keys?: string;
370
+ lastname?: string;
371
+ tokens?: unknown;
372
+ }
373
+ export declare const GetAccessUserResponse: S.Schema<GetAccessUserResponse>;
374
+ export interface GetAccessUserTfaRequest {
375
+ userid: string;
376
+ /** Request all entries as an array. */
377
+ multiple?: string;
378
+ }
379
+ export declare const GetAccessUserTfaRequest: S.Schema<GetAccessUserTfaRequest>;
380
+ export type GetAccessUserTfaResponseRealm = "oath" | "yubico";
381
+ export declare const GetAccessUserTfaResponseRealm: any;
382
+ export type GetAccessUserTfaResponseTypesItem = "totp" | "u2f" | "yubico" | "webauthn" | "recovedry";
383
+ export declare const GetAccessUserTfaResponseTypesItem: any;
384
+ export type GetAccessUserTfaResponseTypesList = Array<GetAccessUserTfaResponseTypesItem>;
385
+ export declare const GetAccessUserTfaResponseTypesList: S.Schema<GetAccessUserTfaResponseTypesList>;
386
+ export type GetAccessUserTfaResponseUser = "oath" | "u2f";
387
+ export declare const GetAccessUserTfaResponseUser: any;
388
+ export interface GetAccessUserTfaResponse {
389
+ realm?: GetAccessUserTfaResponseRealm;
390
+ types?: GetAccessUserTfaResponseTypesList;
391
+ user?: GetAccessUserTfaResponseUser;
392
+ }
393
+ export declare const GetAccessUserTfaResponse: S.Schema<GetAccessUserTfaResponse>;
394
+ export interface GetAccessUserTokenRequest {
395
+ userid: string;
396
+ tokenid: string;
397
+ }
398
+ export declare const GetAccessUserTokenRequest: S.Schema<GetAccessUserTokenRequest>;
399
+ export interface GetAccessUserTokenResponse {
400
+ comment?: string;
401
+ expire?: number;
402
+ privsep?: unknown;
403
+ }
404
+ export declare const GetAccessUserTokenResponse: S.Schema<GetAccessUserTokenResponse>;
405
+ export interface ListAccessRequest {
406
+ }
407
+ export declare const ListAccessRequest: S.Schema<ListAccessRequest>;
408
+ export interface ListAccessResponseBodyItem {
409
+ subdir: string;
410
+ }
411
+ export declare const ListAccessResponseBodyItem: S.Schema<ListAccessResponseBodyItem>;
412
+ export type ListAccessResponseBodyList = Array<ListAccessResponseBodyItem>;
413
+ export declare const ListAccessResponseBodyList: S.Schema<ListAccessResponseBodyList>;
414
+ export type ListAccessResponse = ListAccessResponseBodyList;
415
+ export declare const ListAccessResponse: S.Schema<ListAccessResponse>;
416
+ export interface ListAccessAclRequest {
417
+ }
418
+ export declare const ListAccessAclRequest: S.Schema<ListAccessAclRequest>;
419
+ export type ListAccessAclResponseBodyItemType = "user" | "group" | "token";
420
+ export declare const ListAccessAclResponseBodyItemType: any;
421
+ export interface ListAccessAclResponseBodyItem {
422
+ path: string;
423
+ propagate?: unknown;
424
+ roleid: string;
425
+ type: ListAccessAclResponseBodyItemType;
426
+ ugid: string;
427
+ }
428
+ export declare const ListAccessAclResponseBodyItem: S.Schema<ListAccessAclResponseBodyItem>;
429
+ export type ListAccessAclResponseBodyList = Array<ListAccessAclResponseBodyItem>;
430
+ export declare const ListAccessAclResponseBodyList: S.Schema<ListAccessAclResponseBodyList>;
431
+ export type ListAccessAclResponse = ListAccessAclResponseBodyList;
432
+ export declare const ListAccessAclResponse: S.Schema<ListAccessAclResponse>;
433
+ export interface ListAccessDomainsRequest {
434
+ }
435
+ export declare const ListAccessDomainsRequest: S.Schema<ListAccessDomainsRequest>;
436
+ export type ListAccessDomainsResponseBodyItemTfa = "yubico" | "oath";
437
+ export declare const ListAccessDomainsResponseBodyItemTfa: any;
438
+ export interface ListAccessDomainsResponseBodyItem {
439
+ comment?: string;
440
+ realm: string;
441
+ tfa?: ListAccessDomainsResponseBodyItemTfa;
442
+ type: string;
443
+ }
444
+ export declare const ListAccessDomainsResponseBodyItem: S.Schema<ListAccessDomainsResponseBodyItem>;
445
+ export type ListAccessDomainsResponseBodyList = Array<ListAccessDomainsResponseBodyItem>;
446
+ export declare const ListAccessDomainsResponseBodyList: S.Schema<ListAccessDomainsResponseBodyList>;
447
+ export type ListAccessDomainsResponse = ListAccessDomainsResponseBodyList;
448
+ export declare const ListAccessDomainsResponse: S.Schema<ListAccessDomainsResponse>;
449
+ export interface ListAccessGroupsRequest {
450
+ }
451
+ export declare const ListAccessGroupsRequest: S.Schema<ListAccessGroupsRequest>;
452
+ export interface ListAccessGroupsResponseBodyItem {
453
+ comment?: string;
454
+ groupid: string;
455
+ users?: string;
456
+ }
457
+ export declare const ListAccessGroupsResponseBodyItem: S.Schema<ListAccessGroupsResponseBodyItem>;
458
+ export type ListAccessGroupsResponseBodyList = Array<ListAccessGroupsResponseBodyItem>;
459
+ export declare const ListAccessGroupsResponseBodyList: S.Schema<ListAccessGroupsResponseBodyList>;
460
+ export type ListAccessGroupsResponse = ListAccessGroupsResponseBodyList;
461
+ export declare const ListAccessGroupsResponse: S.Schema<ListAccessGroupsResponse>;
462
+ export interface ListAccessOpenidRequest {
463
+ }
464
+ export declare const ListAccessOpenidRequest: S.Schema<ListAccessOpenidRequest>;
465
+ export type ListAccessOpenidResponseBodyItem = ListAccessResponseBodyItem;
466
+ export declare const ListAccessOpenidResponseBodyItem: S.Schema<ListAccessResponseBodyItem>;
467
+ export type ListAccessOpenidResponseBodyList = Array<ListAccessResponseBodyItem>;
468
+ export declare const ListAccessOpenidResponseBodyList: S.Schema<ListAccessOpenidResponseBodyList>;
469
+ export type ListAccessOpenidResponse = ListAccessOpenidResponseBodyList;
470
+ export declare const ListAccessOpenidResponse: S.Schema<ListAccessOpenidResponse>;
471
+ export interface ListAccessRolesRequest {
472
+ }
473
+ export declare const ListAccessRolesRequest: S.Schema<ListAccessRolesRequest>;
474
+ export interface ListAccessRolesResponseBodyItem {
475
+ privs?: string;
476
+ roleid: string;
477
+ special?: unknown;
478
+ }
479
+ export declare const ListAccessRolesResponseBodyItem: S.Schema<ListAccessRolesResponseBodyItem>;
480
+ export type ListAccessRolesResponseBodyList = Array<ListAccessRolesResponseBodyItem>;
481
+ export declare const ListAccessRolesResponseBodyList: S.Schema<ListAccessRolesResponseBodyList>;
482
+ export type ListAccessRolesResponse = ListAccessRolesResponseBodyList;
483
+ export declare const ListAccessRolesResponse: S.Schema<ListAccessRolesResponse>;
484
+ export interface ListAccessTfaRequest {
485
+ }
486
+ export declare const ListAccessTfaRequest: S.Schema<ListAccessTfaRequest>;
487
+ export type ListAccessTfaResponseBodyItemEntriesItemType = "totp" | "u2f" | "webauthn" | "recovery" | "yubico";
488
+ export declare const ListAccessTfaResponseBodyItemEntriesItemType: any;
489
+ export interface ListAccessTfaResponseBodyItemEntriesItem {
490
+ created: number;
491
+ description: string;
492
+ enable?: unknown;
493
+ id: string;
494
+ type: ListAccessTfaResponseBodyItemEntriesItemType;
495
+ }
496
+ export declare const ListAccessTfaResponseBodyItemEntriesItem: S.Schema<ListAccessTfaResponseBodyItemEntriesItem>;
497
+ export type ListAccessTfaResponseBodyItemEntriesList = Array<ListAccessTfaResponseBodyItemEntriesItem>;
498
+ export declare const ListAccessTfaResponseBodyItemEntriesList: S.Schema<ListAccessTfaResponseBodyItemEntriesList>;
499
+ export interface ListAccessTfaResponseBodyItem {
500
+ entries: ListAccessTfaResponseBodyItemEntriesList;
501
+ tfa_locked_until?: number;
502
+ totp_locked?: unknown;
503
+ userid: string;
504
+ }
505
+ export declare const ListAccessTfaResponseBodyItem: S.Schema<ListAccessTfaResponseBodyItem>;
506
+ export type ListAccessTfaResponseBodyList = Array<ListAccessTfaResponseBodyItem>;
507
+ export declare const ListAccessTfaResponseBodyList: S.Schema<ListAccessTfaResponseBodyList>;
508
+ export type ListAccessTfaResponse = ListAccessTfaResponseBodyList;
509
+ export declare const ListAccessTfaResponse: S.Schema<ListAccessTfaResponse>;
510
+ export interface ListAccessUsersRequest {
511
+ /** Optional filter for enable property. */
512
+ enabled?: string;
513
+ /** Include group and token information. */
514
+ full?: string;
515
+ }
516
+ export declare const ListAccessUsersRequest: S.Schema<ListAccessUsersRequest>;
517
+ export interface ListAccessUsersResponseBodyItemTokensItem {
518
+ comment?: string;
519
+ expire?: number;
520
+ privsep?: unknown;
521
+ tokenid: string;
522
+ }
523
+ export declare const ListAccessUsersResponseBodyItemTokensItem: S.Schema<ListAccessUsersResponseBodyItemTokensItem>;
524
+ export type ListAccessUsersResponseBodyItemTokensList = Array<ListAccessUsersResponseBodyItemTokensItem>;
525
+ export declare const ListAccessUsersResponseBodyItemTokensList: S.Schema<ListAccessUsersResponseBodyItemTokensList>;
526
+ export interface ListAccessUsersResponseBodyItem {
527
+ comment?: string;
528
+ email?: string;
529
+ enable?: unknown;
530
+ expire?: number;
531
+ firstname?: string;
532
+ groups?: string;
533
+ keys?: string;
534
+ lastname?: string;
535
+ realm_type?: string;
536
+ tfa_locked_until?: number;
537
+ tokens?: ListAccessUsersResponseBodyItemTokensList;
538
+ totp_locked?: unknown;
539
+ userid: string;
540
+ }
541
+ export declare const ListAccessUsersResponseBodyItem: S.Schema<ListAccessUsersResponseBodyItem>;
542
+ export type ListAccessUsersResponseBodyList = Array<ListAccessUsersResponseBodyItem>;
543
+ export declare const ListAccessUsersResponseBodyList: S.Schema<ListAccessUsersResponseBodyList>;
544
+ export type ListAccessUsersResponse = ListAccessUsersResponseBodyList;
545
+ export declare const ListAccessUsersResponse: S.Schema<ListAccessUsersResponse>;
546
+ export interface ListAccessUserTokenRequest {
547
+ userid: string;
548
+ }
549
+ export declare const ListAccessUserTokenRequest: S.Schema<ListAccessUserTokenRequest>;
550
+ export type ListAccessUserTokenResponseBodyItem = ListAccessUsersResponseBodyItemTokensItem;
551
+ export declare const ListAccessUserTokenResponseBodyItem: S.Schema<ListAccessUsersResponseBodyItemTokensItem>;
552
+ export type ListAccessUserTokenResponseBodyList = Array<ListAccessUsersResponseBodyItemTokensItem>;
553
+ export declare const ListAccessUserTokenResponseBodyList: S.Schema<ListAccessUserTokenResponseBodyList>;
554
+ export type ListAccessUserTokenResponse = ListAccessUserTokenResponseBodyList;
555
+ export declare const ListAccessUserTokenResponse: S.Schema<ListAccessUserTokenResponse>;
556
+ export interface LoginAccessOpenidRequest {
557
+ /** OpenId authorization code. */
558
+ code: string;
559
+ /** Redirection Url. The client should set this to the used server url (location.origin). */
560
+ redirect_url: string;
561
+ /** OpenId state. */
562
+ state: string;
563
+ }
564
+ export declare const LoginAccessOpenidRequest: S.Schema<LoginAccessOpenidRequest>;
565
+ export type LoginAccessOpenidResponse = unknown;
566
+ export declare const LoginAccessOpenidResponse: S.Schema<LoginAccessOpenidResponse>;
567
+ export interface PutAccessAclRequest {
568
+ /** Remove permissions (instead of adding it). */
569
+ delete?: string;
570
+ /** List of groups. */
571
+ groups?: string;
572
+ /** Access control path */
573
+ path: string;
574
+ /** Allow to propagate (inherit) permissions. */
575
+ propagate?: string;
576
+ /** List of roles. */
577
+ roles: string;
578
+ /** List of API tokens. */
579
+ tokens?: string;
580
+ /** List of users. */
581
+ users?: string;
582
+ }
583
+ export declare const PutAccessAclRequest: S.Schema<PutAccessAclRequest>;
584
+ export interface PutAccessAclResponse {
585
+ }
586
+ export declare const PutAccessAclResponse: S.Schema<PutAccessAclResponse>;
587
+ export type PutAccessDomainRequestMode = "ldap" | "ldaps" | "ldap+starttls";
588
+ export declare const PutAccessDomainRequestMode: any;
589
+ export type PutAccessDomainRequestSslversion = "tlsv1" | "tlsv1_1" | "tlsv1_2" | "tlsv1_3";
590
+ export declare const PutAccessDomainRequestSslversion: any;
591
+ export interface PutAccessDomainRequest {
592
+ realm: string;
593
+ /** Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. */
594
+ acr_values?: string;
595
+ /** A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. */
596
+ audiences?: string;
597
+ /** Automatically create users if they do not exist. */
598
+ autocreate?: string;
599
+ /** LDAP base domain name */
600
+ base_dn?: string;
601
+ /** LDAP bind domain name */
602
+ bind_dn?: string;
603
+ /** Path to the CA certificate store */
604
+ capath?: string;
605
+ /** username is case-sensitive */
606
+ case_sensitive?: string;
607
+ /** Path to the client certificate */
608
+ cert?: string;
609
+ /** Path to the client certificate key */
610
+ certkey?: string;
611
+ /** Check bind connection to the server. */
612
+ check_connection?: string;
613
+ /** OpenID Client ID */
614
+ client_id?: string;
615
+ /** OpenID Client Key */
616
+ client_key?: string;
617
+ /** Description. */
618
+ comment?: string;
619
+ /** Use this as default realm */
620
+ default?: string;
621
+ /** A list of settings you want to delete. */
622
+ delete?: string;
623
+ /** Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. */
624
+ digest?: string;
625
+ /** AD domain name */
626
+ domain?: string;
627
+ /** LDAP filter for user sync. */
628
+ filter?: string;
629
+ /** The objectclasses for groups. */
630
+ group_classes?: string;
631
+ /** LDAP base domain name for group sync. If not set, the base_dn will be used. */
632
+ group_dn?: string;
633
+ /** LDAP filter for group sync. */
634
+ group_filter?: string;
635
+ /** LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. */
636
+ group_name_attr?: string;
637
+ /** Automatically create groups if they do not exist. */
638
+ groups_autocreate?: string;
639
+ /** OpenID claim used to retrieve groups with. */
640
+ groups_claim?: string;
641
+ /** All groups will be overwritten for the user on login. */
642
+ groups_overwrite?: string;
643
+ /** OpenID Issuer Url */
644
+ issuer_url?: string;
645
+ /** LDAP protocol mode. */
646
+ mode?: PutAccessDomainRequestMode | (string & {});
647
+ /** LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. */
648
+ password?: string;
649
+ /** Server port. */
650
+ port?: string;
651
+ /** Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. */
652
+ prompt?: string;
653
+ /** Enables querying the userinfo endpoint for claims values. */
654
+ query_userinfo?: string;
655
+ /** Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. */
656
+ scopes?: string;
657
+ /** Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. */
658
+ secure?: string;
659
+ /** Server IP address (or DNS name) */
660
+ server1?: string;
661
+ /** Fallback Server IP address (or DNS name) */
662
+ server2?: string;
663
+ /** LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! */
664
+ sslversion?: PutAccessDomainRequestSslversion | (string & {});
665
+ /** The default options for behavior of synchronizations. */
666
+ sync_defaults_options?: string;
667
+ /** Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. */
668
+ sync_attributes?: string;
669
+ /** Use Two-factor authentication. */
670
+ tfa?: string;
671
+ /** LDAP user attribute name */
672
+ user_attr?: string;
673
+ /** The objectclasses for users. */
674
+ user_classes?: string;
675
+ /** Verify the server's SSL certificate */
676
+ verify?: string;
677
+ }
678
+ export declare const PutAccessDomainRequest: S.Schema<PutAccessDomainRequest>;
679
+ export interface PutAccessDomainResponse {
680
+ }
681
+ export declare const PutAccessDomainResponse: S.Schema<PutAccessDomainResponse>;
682
+ export interface PutAccessGroupRequest {
683
+ groupid: string;
684
+ comment?: string;
685
+ }
686
+ export declare const PutAccessGroupRequest: S.Schema<PutAccessGroupRequest>;
687
+ export interface PutAccessGroupResponse {
688
+ }
689
+ export declare const PutAccessGroupResponse: S.Schema<PutAccessGroupResponse>;
690
+ export interface PutAccessPasswordRequest {
691
+ /** The current password of the user performing the change. */
692
+ confirmation_password?: string;
693
+ /** The new password. */
694
+ password: string;
695
+ /** Full User ID, in the `name@realm` format. */
696
+ userid: string;
697
+ }
698
+ export declare const PutAccessPasswordRequest: S.Schema<PutAccessPasswordRequest>;
699
+ export interface PutAccessPasswordResponse {
700
+ }
701
+ export declare const PutAccessPasswordResponse: S.Schema<PutAccessPasswordResponse>;
702
+ export interface PutAccessRoleRequest {
703
+ roleid: string;
704
+ append?: string;
705
+ privs?: string;
706
+ }
707
+ export declare const PutAccessRoleRequest: S.Schema<PutAccessRoleRequest>;
708
+ export interface PutAccessRoleResponse {
709
+ }
710
+ export declare const PutAccessRoleResponse: S.Schema<PutAccessRoleResponse>;
711
+ export interface PutAccessTfaRequest {
712
+ userid: string;
713
+ id: string;
714
+ /** A description to distinguish multiple entries from one another */
715
+ description?: string;
716
+ /** Whether the entry should be enabled for login. */
717
+ enable?: string;
718
+ /** The current password of the user performing the change. */
719
+ password?: string;
720
+ }
721
+ export declare const PutAccessTfaRequest: S.Schema<PutAccessTfaRequest>;
722
+ export interface PutAccessTfaResponse {
723
+ }
724
+ export declare const PutAccessTfaResponse: S.Schema<PutAccessTfaResponse>;
725
+ export interface PutAccessUserRequest {
726
+ userid: string;
727
+ append?: string;
728
+ comment?: string;
729
+ email?: string;
730
+ /** Enable the account (default). You can set this to '0' to disable the account */
731
+ enable?: string;
732
+ /** Account expiration date (seconds since epoch). '0' means no expiration date. */
733
+ expire?: string;
734
+ firstname?: string;
735
+ groups?: string;
736
+ /** Keys for two factor auth (yubico). */
737
+ keys?: string;
738
+ lastname?: string;
739
+ }
740
+ export declare const PutAccessUserRequest: S.Schema<PutAccessUserRequest>;
741
+ export interface PutAccessUserResponse {
742
+ }
743
+ export declare const PutAccessUserResponse: S.Schema<PutAccessUserResponse>;
744
+ export interface PutAccessUserTokenRequest {
745
+ userid: string;
746
+ tokenid: string;
747
+ comment?: string;
748
+ /** A list of settings you want to delete. */
749
+ delete?: string;
750
+ /** API token expiration date (seconds since epoch). '0' means no expiration date. */
751
+ expire?: string;
752
+ /** Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. */
753
+ privsep?: string;
754
+ /** Regenerate the token's secret value. All users of the previous secret will lose access after this operation. */
755
+ regenerate?: string;
756
+ }
757
+ export declare const PutAccessUserTokenRequest: S.Schema<PutAccessUserTokenRequest>;
758
+ export interface PutAccessUserTokenResponse {
759
+ comment?: string;
760
+ expire?: number;
761
+ full_tokenid?: string;
762
+ privsep?: unknown;
763
+ value?: string;
764
+ }
765
+ export declare const PutAccessUserTokenResponse: S.Schema<PutAccessUserTokenResponse>;
766
+ export interface PutAccessUserUnlockTfaRequest {
767
+ userid: string;
768
+ }
769
+ export declare const PutAccessUserUnlockTfaRequest: S.Schema<PutAccessUserUnlockTfaRequest>;
770
+ export type PutAccessUserUnlockTfaResponse = unknown;
771
+ export declare const PutAccessUserUnlockTfaResponse: S.Schema<PutAccessUserUnlockTfaResponse>;
772
+ export type SyncAccessDomainRequestScope = "users" | "groups" | "both";
773
+ export declare const SyncAccessDomainRequestScope: any;
774
+ export interface SyncAccessDomainRequest {
775
+ realm: string;
776
+ /** If set, does not write anything. */
777
+ dry_run?: string;
778
+ /** Enable newly synced users immediately. */
779
+ enable_new: string;
780
+ /** DEPRECATED: use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. */
781
+ full: string;
782
+ /** DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. */
783
+ purge: string;
784
+ /** A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). */
785
+ remove_vanished: string;
786
+ /** Select what to sync. */
787
+ scope: SyncAccessDomainRequestScope | (string & {});
788
+ }
789
+ export declare const SyncAccessDomainRequest: S.Schema<SyncAccessDomainRequest>;
790
+ export type SyncAccessDomainResponse = string;
791
+ export declare const SyncAccessDomainResponse: S.Schema<SyncAccessDomainResponse>;
792
+ export type UpdateAccessTfaRequestType = "totp" | "u2f" | "webauthn" | "recovery" | "yubico";
793
+ export declare const UpdateAccessTfaRequestType: any;
794
+ export interface UpdateAccessTfaRequest {
795
+ userid: string;
796
+ /** When responding to a u2f challenge: the original challenge string */
797
+ challenge?: string;
798
+ /** A description to distinguish multiple entries from one another */
799
+ description?: string;
800
+ /** The current password of the user performing the change. */
801
+ password?: string;
802
+ /** A totp URI. */
803
+ totp?: string;
804
+ /** TFA Entry Type. */
805
+ type: UpdateAccessTfaRequestType | (string & {});
806
+ /** The current value for the provided totp URI, or a Webauthn/U2F challenge response */
807
+ value?: string;
808
+ }
809
+ export declare const UpdateAccessTfaRequest: S.Schema<UpdateAccessTfaRequest>;
810
+ export type UpdateAccessTfaResponseRecoveryList = Array<string>;
811
+ export declare const UpdateAccessTfaResponseRecoveryList: S.Schema<UpdateAccessTfaResponseRecoveryList>;
812
+ export interface UpdateAccessTfaResponse {
813
+ challenge?: string;
814
+ id: string;
815
+ recovery?: UpdateAccessTfaResponseRecoveryList;
816
+ }
817
+ export declare const UpdateAccessTfaResponse: S.Schema<UpdateAccessTfaResponse>;
818
+ export interface UpdateAccessUserTokenRequest {
819
+ userid: string;
820
+ tokenid: string;
821
+ comment?: string;
822
+ /** API token expiration date (seconds since epoch). '0' means no expiration date. */
823
+ expire?: string;
824
+ /** Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. */
825
+ privsep?: string;
826
+ }
827
+ export declare const UpdateAccessUserTokenRequest: S.Schema<UpdateAccessUserTokenRequest>;
828
+ export interface UpdateAccessUserTokenResponseInfo {
829
+ comment?: string;
830
+ expire?: number;
831
+ privsep?: unknown;
832
+ }
833
+ export declare const UpdateAccessUserTokenResponseInfo: S.Schema<UpdateAccessUserTokenResponseInfo>;
834
+ export interface UpdateAccessUserTokenResponse {
835
+ full_tokenid?: string;
836
+ info: UpdateAccessUserTokenResponseInfo;
837
+ value: string;
838
+ }
839
+ export declare const UpdateAccessUserTokenResponse: S.Schema<UpdateAccessUserTokenResponse>;
840
+ export type CreateAccessDomainError = ProxmoxOpError;
841
+ /** Add an authentication server. (root-privileged endpoint) */
842
+ export declare const createAccessDomain: API.OperationMethod<CreateAccessDomainRequest, CreateAccessDomainResponse, CreateAccessDomainError, ProxmoxOpContext>;
843
+ export type CreateAccessGroupError = ProxmoxOpError;
844
+ /** Create new group. (root-privileged endpoint) */
845
+ export declare const createAccessGroup: API.OperationMethod<CreateAccessGroupRequest, CreateAccessGroupResponse, CreateAccessGroupError, ProxmoxOpContext>;
846
+ export type CreateAccessOpenidAuthUrlError = ProxmoxOpError;
847
+ /** Get the OpenId Authorization Url for the specified realm. (root-privileged endpoint) */
848
+ export declare const createAccessOpenidAuthUrl: API.OperationMethod<CreateAccessOpenidAuthUrlRequest, CreateAccessOpenidAuthUrlResponse, CreateAccessOpenidAuthUrlError, ProxmoxOpContext>;
849
+ export type CreateAccessRoleError = ProxmoxOpError;
850
+ /** Create new role. (root-privileged endpoint) */
851
+ export declare const createAccessRole: API.OperationMethod<CreateAccessRoleRequest, CreateAccessRoleResponse, CreateAccessRoleError, ProxmoxOpContext>;
852
+ export type CreateAccessTicketError = ProxmoxOpError;
853
+ /** Create or verify authentication ticket. (root-privileged endpoint) */
854
+ export declare const createAccessTicket: API.OperationMethod<CreateAccessTicketRequest, CreateAccessTicketResponse, CreateAccessTicketError, ProxmoxOpContext>;
855
+ export type CreateAccessUserError = ProxmoxOpError;
856
+ /** Create new user. (root-privileged endpoint) */
857
+ export declare const createAccessUser: API.OperationMethod<CreateAccessUserRequest, CreateAccessUserResponse, CreateAccessUserError, ProxmoxOpContext>;
858
+ export type CreateAccessVncticketError = ProxmoxOpError;
859
+ /** verify VNC authentication ticket. (root-privileged endpoint) */
860
+ export declare const createAccessVncticket: API.OperationMethod<CreateAccessVncticketRequest, CreateAccessVncticketResponse, CreateAccessVncticketError, ProxmoxOpContext>;
861
+ export type DeleteAccessDomainError = ProxmoxOpError;
862
+ /** Delete an authentication server. (root-privileged endpoint) */
863
+ export declare const deleteAccessDomain: API.OperationMethod<DeleteAccessDomainRequest, DeleteAccessDomainResponse, DeleteAccessDomainError, ProxmoxOpContext>;
864
+ export type DeleteAccessGroupError = ProxmoxOpError;
865
+ /** Delete group. (root-privileged endpoint) */
866
+ export declare const deleteAccessGroup: API.OperationMethod<DeleteAccessGroupRequest, DeleteAccessGroupResponse, DeleteAccessGroupError, ProxmoxOpContext>;
867
+ export type DeleteAccessRoleError = ProxmoxOpError;
868
+ /** Delete role. (root-privileged endpoint) */
869
+ export declare const deleteAccessRole: API.OperationMethod<DeleteAccessRoleRequest, DeleteAccessRoleResponse, DeleteAccessRoleError, ProxmoxOpContext>;
870
+ export type DeleteAccessTfaError = ProxmoxOpError;
871
+ /** Delete a TFA entry by ID. (root-privileged endpoint) */
872
+ export declare const deleteAccessTfa: API.OperationMethod<DeleteAccessTfaRequest, DeleteAccessTfaResponse, DeleteAccessTfaError, ProxmoxOpContext>;
873
+ export type DeleteAccessUserError = ProxmoxOpError;
874
+ /** Delete user. (root-privileged endpoint) */
875
+ export declare const deleteAccessUser: API.OperationMethod<DeleteAccessUserRequest, DeleteAccessUserResponse, DeleteAccessUserError, ProxmoxOpContext>;
876
+ export type DeleteAccessUserTokenError = ProxmoxOpError;
877
+ /** Remove API token for a specific user. (root-privileged endpoint) */
878
+ export declare const deleteAccessUserToken: API.OperationMethod<DeleteAccessUserTokenRequest, DeleteAccessUserTokenResponse, DeleteAccessUserTokenError, ProxmoxOpContext>;
879
+ export type GetAccessDomainError = ProxmoxOpError;
880
+ /** Get auth server configuration. */
881
+ export declare const getAccessDomain: API.OperationMethod<GetAccessDomainRequest, GetAccessDomainResponse, GetAccessDomainError, ProxmoxOpContext>;
882
+ export type GetAccessGroupError = ProxmoxOpError;
883
+ /** Get group configuration. */
884
+ export declare const getAccessGroup: API.OperationMethod<GetAccessGroupRequest, GetAccessGroupResponse, GetAccessGroupError, ProxmoxOpContext>;
885
+ export type GetAccessPermissionsError = ProxmoxOpError;
886
+ /** Retrieve effective permissions of given user/token. */
887
+ export declare const getAccessPermissions: API.OperationMethod<GetAccessPermissionsRequest, GetAccessPermissionsResponse, GetAccessPermissionsError, ProxmoxOpContext>;
888
+ export type GetAccessRoleError = ProxmoxOpError;
889
+ /** Get role configuration. */
890
+ export declare const getAccessRole: API.OperationMethod<GetAccessRoleRequest, GetAccessRoleResponse, GetAccessRoleError, ProxmoxOpContext>;
891
+ export type GetAccessTfaError = ProxmoxOpError;
892
+ /** List TFA configurations of users. (root-privileged endpoint) */
893
+ export declare const getAccessTfa: API.OperationMethod<GetAccessTfaRequest, GetAccessTfaResponse, GetAccessTfaError, ProxmoxOpContext>;
894
+ export type GetAccessTfa2Error = ProxmoxOpError;
895
+ /** Fetch a requested TFA entry if present. (root-privileged endpoint) */
896
+ export declare const getAccessTfa2: API.OperationMethod<GetAccessTfa2Request, GetAccessTfa2Response, GetAccessTfa2Error, ProxmoxOpContext>;
897
+ export type GetAccessTicketError = ProxmoxOpError;
898
+ /** Dummy. Useful for formatters which want to provide a login page. */
899
+ export declare const getAccessTicket: API.OperationMethod<GetAccessTicketRequest, GetAccessTicketResponse, GetAccessTicketError, ProxmoxOpContext>;
900
+ export type GetAccessUserError = ProxmoxOpError;
901
+ /** Get user configuration. */
902
+ export declare const getAccessUser: API.OperationMethod<GetAccessUserRequest, GetAccessUserResponse, GetAccessUserError, ProxmoxOpContext>;
903
+ export type GetAccessUserTfaError = ProxmoxOpError;
904
+ /** Get user TFA types (Personal and Realm). (root-privileged endpoint) */
905
+ export declare const getAccessUserTfa: API.OperationMethod<GetAccessUserTfaRequest, GetAccessUserTfaResponse, GetAccessUserTfaError, ProxmoxOpContext>;
906
+ export type GetAccessUserTokenError = ProxmoxOpError;
907
+ /** Get specific API token information. */
908
+ export declare const getAccessUserToken: API.OperationMethod<GetAccessUserTokenRequest, GetAccessUserTokenResponse, GetAccessUserTokenError, ProxmoxOpContext>;
909
+ export type ListAccessError = ProxmoxOpError;
910
+ /** Directory index. */
911
+ export declare const listAccess: API.OperationMethod<ListAccessRequest, ListAccessResponse, ListAccessError, ProxmoxOpContext>;
912
+ export type ListAccessAclError = ProxmoxOpError;
913
+ /** Get Access Control List (ACLs). */
914
+ export declare const listAccessAcl: API.OperationMethod<ListAccessAclRequest, ListAccessAclResponse, ListAccessAclError, ProxmoxOpContext>;
915
+ export type ListAccessDomainsError = ProxmoxOpError;
916
+ /** Authentication domain index. */
917
+ export declare const listAccessDomains: API.OperationMethod<ListAccessDomainsRequest, ListAccessDomainsResponse, ListAccessDomainsError, ProxmoxOpContext>;
918
+ export type ListAccessGroupsError = ProxmoxOpError;
919
+ /** Group index. */
920
+ export declare const listAccessGroups: API.OperationMethod<ListAccessGroupsRequest, ListAccessGroupsResponse, ListAccessGroupsError, ProxmoxOpContext>;
921
+ export type ListAccessOpenidError = ProxmoxOpError;
922
+ /** Directory index. */
923
+ export declare const listAccessOpenid: API.OperationMethod<ListAccessOpenidRequest, ListAccessOpenidResponse, ListAccessOpenidError, ProxmoxOpContext>;
924
+ export type ListAccessRolesError = ProxmoxOpError;
925
+ /** Role index. */
926
+ export declare const listAccessRoles: API.OperationMethod<ListAccessRolesRequest, ListAccessRolesResponse, ListAccessRolesError, ProxmoxOpContext>;
927
+ export type ListAccessTfaError = ProxmoxOpError;
928
+ /** List TFA configurations of users. (root-privileged endpoint) */
929
+ export declare const listAccessTfa: API.OperationMethod<ListAccessTfaRequest, ListAccessTfaResponse, ListAccessTfaError, ProxmoxOpContext>;
930
+ export type ListAccessUsersError = ProxmoxOpError;
931
+ /** User index. (root-privileged endpoint) */
932
+ export declare const listAccessUsers: API.OperationMethod<ListAccessUsersRequest, ListAccessUsersResponse, ListAccessUsersError, ProxmoxOpContext>;
933
+ export type ListAccessUserTokenError = ProxmoxOpError;
934
+ /** Get user API tokens. */
935
+ export declare const listAccessUserToken: API.OperationMethod<ListAccessUserTokenRequest, ListAccessUserTokenResponse, ListAccessUserTokenError, ProxmoxOpContext>;
936
+ export type LoginAccessOpenidError = ProxmoxOpError;
937
+ /** Verify OpenID authorization code and create a ticket. (root-privileged endpoint) */
938
+ export declare const loginAccessOpenid: API.OperationMethod<LoginAccessOpenidRequest, LoginAccessOpenidResponse, LoginAccessOpenidError, ProxmoxOpContext>;
939
+ export type PutAccessAclError = ProxmoxOpError;
940
+ /** Update Access Control List (add or remove permissions). (root-privileged endpoint) */
941
+ export declare const putAccessAcl: API.OperationMethod<PutAccessAclRequest, PutAccessAclResponse, PutAccessAclError, ProxmoxOpContext>;
942
+ export type PutAccessDomainError = ProxmoxOpError;
943
+ /** Update authentication server settings. (root-privileged endpoint) */
944
+ export declare const putAccessDomain: API.OperationMethod<PutAccessDomainRequest, PutAccessDomainResponse, PutAccessDomainError, ProxmoxOpContext>;
945
+ export type PutAccessGroupError = ProxmoxOpError;
946
+ /** Update group data. (root-privileged endpoint) */
947
+ export declare const putAccessGroup: API.OperationMethod<PutAccessGroupRequest, PutAccessGroupResponse, PutAccessGroupError, ProxmoxOpContext>;
948
+ export type PutAccessPasswordError = ProxmoxOpError;
949
+ /** Change user password. (root-privileged endpoint) */
950
+ export declare const putAccessPassword: API.OperationMethod<PutAccessPasswordRequest, PutAccessPasswordResponse, PutAccessPasswordError, ProxmoxOpContext>;
951
+ export type PutAccessRoleError = ProxmoxOpError;
952
+ /** Update an existing role. (root-privileged endpoint) */
953
+ export declare const putAccessRole: API.OperationMethod<PutAccessRoleRequest, PutAccessRoleResponse, PutAccessRoleError, ProxmoxOpContext>;
954
+ export type PutAccessTfaError = ProxmoxOpError;
955
+ /** Add a TFA entry for a user. (root-privileged endpoint) */
956
+ export declare const putAccessTfa: API.OperationMethod<PutAccessTfaRequest, PutAccessTfaResponse, PutAccessTfaError, ProxmoxOpContext>;
957
+ export type PutAccessUserError = ProxmoxOpError;
958
+ /** Update user configuration. (root-privileged endpoint) */
959
+ export declare const putAccessUser: API.OperationMethod<PutAccessUserRequest, PutAccessUserResponse, PutAccessUserError, ProxmoxOpContext>;
960
+ export type PutAccessUserTokenError = ProxmoxOpError;
961
+ /** Update API token for a specific user. NOTE: when 'regenerate' is set, the returned token value needs to be stored as it cannot be retrieved afterwards! (root-privileged endpoint) */
962
+ export declare const putAccessUserToken: API.OperationMethod<PutAccessUserTokenRequest, PutAccessUserTokenResponse, PutAccessUserTokenError, ProxmoxOpContext>;
963
+ export type PutAccessUserUnlockTfaError = ProxmoxOpError;
964
+ /** Unlock a user's TFA authentication. (root-privileged endpoint) */
965
+ export declare const putAccessUserUnlockTfa: API.OperationMethod<PutAccessUserUnlockTfaRequest, PutAccessUserUnlockTfaResponse, PutAccessUserUnlockTfaError, ProxmoxOpContext>;
966
+ export type SyncAccessDomainError = ProxmoxOpError;
967
+ /** Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. (root-privileged endpoint) */
968
+ export declare const syncAccessDomain: API.OperationMethod<SyncAccessDomainRequest, SyncAccessDomainResponse, SyncAccessDomainError, ProxmoxOpContext>;
969
+ export type UpdateAccessTfaError = ProxmoxOpError;
970
+ /** Add a TFA entry for a user. (root-privileged endpoint) */
971
+ export declare const updateAccessTfa: API.OperationMethod<UpdateAccessTfaRequest, UpdateAccessTfaResponse, UpdateAccessTfaError, ProxmoxOpContext>;
972
+ export type UpdateAccessUserTokenError = ProxmoxOpError;
973
+ /** Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! (root-privileged endpoint) */
974
+ export declare const updateAccessUserToken: API.OperationMethod<UpdateAccessUserTokenRequest, UpdateAccessUserTokenResponse, UpdateAccessUserTokenError, ProxmoxOpContext>;
975
+ //# sourceMappingURL=access.d.ts.map