@clientapi/pbs 2026.5.24

package/dist/esm/apis/AccessTicketApi.js

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Proxmox Backup Server API
+ * Generated from apidoc.js. NOT an official Proxmox specification. See https://pbs.proxmox.com/docs/api-viewer/ for the upstream documentation.
+ *
+ * The version of the OpenAPI document: 9.x
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { AccessTicketCreateTicketRequestToJSON, } from '../models/AccessTicketCreateTicketRequest';
+import { AccessTicketCreateTicketResponseFromJSON, } from '../models/AccessTicketCreateTicketResponse';
+import { AccessTicketDeleteTicketResponseFromJSON, } from '../models/AccessTicketDeleteTicketResponse';
+/**
+ *
+ */
+export class AccessTicketApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTicket without sending the request
+     */
+    async createTicketRequestOpts(requestParameters) {
+        if (requestParameters['accessTicketCreateTicketRequest'] == null) {
+            throw new runtime.RequiredError('accessTicketCreateTicketRequest', 'Required parameter "accessTicketCreateTicketRequest" was null or undefined when calling createTicket().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        let urlPath = `/access/ticket`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AccessTicketCreateTicketRequestToJSON(requestParameters['accessTicketCreateTicketRequest']),
+        };
+    }
+    /**
+     * Either create a new HttpOnly ticket or a regular ticket.
+     * Either create a new HttpOnly ticket or a regular ticket
+     */
+    async createTicketRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createTicketRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccessTicketCreateTicketResponseFromJSON(jsonValue));
+    }
+    /**
+     * Either create a new HttpOnly ticket or a regular ticket.
+     * Either create a new HttpOnly ticket or a regular ticket
+     */
+    async createTicket(requestParameters, initOverrides) {
+        const response = await this.createTicketRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for deleteTicket without sending the request
+     */
+    async deleteTicketRequestOpts() {
+        const queryParameters = {};
+        const headerParameters = {};
+        let urlPath = `/access/ticket`;
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     *
+     * AccessTicket_delete_ticket
+     */
+    async deleteTicketRaw(initOverrides) {
+        const requestOptions = await this.deleteTicketRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccessTicketDeleteTicketResponseFromJSON(jsonValue));
+    }
+    /**
+     *
+     * AccessTicket_delete_ticket
+     */
+    async deleteTicket(initOverrides) {
+        const response = await this.deleteTicketRaw(initOverrides);
+        return await response.value();
+    }
+}

package/dist/esm/apis/AccessUsersApi.d.ts

@@ -0,0 +1,228 @@
+/**
+ * Proxmox Backup Server API
+ * Generated from apidoc.js. NOT an official Proxmox specification. See https://pbs.proxmox.com/docs/api-viewer/ for the upstream documentation.
+ *
+ * The version of the OpenAPI document: 9.x
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type AccessUsersCreateTokenRequest } from '../models/AccessUsersCreateTokenRequest';
+import { type AccessUsersCreateTokenResponse } from '../models/AccessUsersCreateTokenResponse';
+import { type AccessUsersCreateUsersRequest } from '../models/AccessUsersCreateUsersRequest';
+import { type AccessUsersCreateUsersResponse } from '../models/AccessUsersCreateUsersResponse';
+import { type AccessUsersDeleteTokenResponse } from '../models/AccessUsersDeleteTokenResponse';
+import { type AccessUsersDeleteUsersResponse } from '../models/AccessUsersDeleteUsersResponse';
+import { type AccessUsersGetAccessUsersByUseridResponse } from '../models/AccessUsersGetAccessUsersByUseridResponse';
+import { type AccessUsersGetAccessUsersByUseridTokenByTokenNameResponse } from '../models/AccessUsersGetAccessUsersByUseridTokenByTokenNameResponse';
+import { type AccessUsersGetTokenResponse } from '../models/AccessUsersGetTokenResponse';
+import { type AccessUsersGetUsersResponse } from '../models/AccessUsersGetUsersResponse';
+import { type AccessUsersUpdateTokenRequest } from '../models/AccessUsersUpdateTokenRequest';
+import { type AccessUsersUpdateTokenResponse } from '../models/AccessUsersUpdateTokenResponse';
+import { type AccessUsersUpdateUnlockTfaResponse } from '../models/AccessUsersUpdateUnlockTfaResponse';
+import { type AccessUsersUpdateUsersRequest } from '../models/AccessUsersUpdateUsersRequest';
+import { type AccessUsersUpdateUsersResponse } from '../models/AccessUsersUpdateUsersResponse';
+export interface AccessUsersApiCreateTokenRequest {
+    tokenName: string;
+    userid: string;
+    accessUsersCreateTokenRequest?: AccessUsersCreateTokenRequest;
+}
+export interface AccessUsersApiCreateUsersRequest {
+    accessUsersCreateUsersRequest: AccessUsersCreateUsersRequest;
+}
+export interface AccessUsersApiDeleteTokenRequest {
+    tokenName: string;
+    userid: string;
+    digest?: string;
+}
+export interface AccessUsersApiDeleteUsersRequest {
+    userid: string;
+    digest?: string;
+}
+export interface AccessUsersApiGetAccessUsersByUseridRequest {
+    userid: string;
+}
+export interface AccessUsersApiGetAccessUsersByUseridTokenByTokenNameRequest {
+    tokenName: string;
+    userid: string;
+}
+export interface AccessUsersApiGetTokenRequest {
+    userid: string;
+}
+export interface AccessUsersApiGetUsersRequest {
+    includeTokens?: boolean;
+}
+export interface AccessUsersApiUpdateTokenRequest {
+    tokenName: string;
+    userid: string;
+    accessUsersUpdateTokenRequest?: AccessUsersUpdateTokenRequest;
+}
+export interface AccessUsersApiUpdateUnlockTfaRequest {
+    userid: string;
+}
+export interface AccessUsersApiUpdateUsersRequest {
+    userid: string;
+    accessUsersUpdateUsersRequest?: AccessUsersUpdateUsersRequest;
+}
+/**
+ *
+ */
+export declare class AccessUsersApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createToken without sending the request
+     */
+    createTokenRequestOpts(requestParameters: AccessUsersApiCreateTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Generate a new API token with given metadata
+     * Generate a new API token with given metadata
+     */
+    createTokenRaw(requestParameters: AccessUsersApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersCreateTokenResponse>>;
+    /**
+     * Generate a new API token with given metadata
+     * Generate a new API token with given metadata
+     */
+    createToken(requestParameters: AccessUsersApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersCreateTokenResponse>;
+    /**
+     * Creates request options for createUsers without sending the request
+     */
+    createUsersRequestOpts(requestParameters: AccessUsersApiCreateUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create new user.
+     * Create new user
+     */
+    createUsersRaw(requestParameters: AccessUsersApiCreateUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersCreateUsersResponse>>;
+    /**
+     * Create new user.
+     * Create new user
+     */
+    createUsers(requestParameters: AccessUsersApiCreateUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersCreateUsersResponse>;
+    /**
+     * Creates request options for deleteToken without sending the request
+     */
+    deleteTokenRequestOpts(requestParameters: AccessUsersApiDeleteTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a user\'s API token
+     * Delete a user\'s API token
+     */
+    deleteTokenRaw(requestParameters: AccessUsersApiDeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersDeleteTokenResponse>>;
+    /**
+     * Delete a user\'s API token
+     * Delete a user\'s API token
+     */
+    deleteToken(requestParameters: AccessUsersApiDeleteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersDeleteTokenResponse>;
+    /**
+     * Creates request options for deleteUsers without sending the request
+     */
+    deleteUsersRequestOpts(requestParameters: AccessUsersApiDeleteUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Remove a user from the configuration file.
+     * Remove a user from the configuration file
+     */
+    deleteUsersRaw(requestParameters: AccessUsersApiDeleteUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersDeleteUsersResponse>>;
+    /**
+     * Remove a user from the configuration file.
+     * Remove a user from the configuration file
+     */
+    deleteUsers(requestParameters: AccessUsersApiDeleteUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersDeleteUsersResponse>;
+    /**
+     * Creates request options for getAccessUsersByUserid without sending the request
+     */
+    getAccessUsersByUseridRequestOpts(requestParameters: AccessUsersApiGetAccessUsersByUseridRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read user configuration data.
+     * Read user configuration data
+     */
+    getAccessUsersByUseridRaw(requestParameters: AccessUsersApiGetAccessUsersByUseridRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersGetAccessUsersByUseridResponse>>;
+    /**
+     * Read user configuration data.
+     * Read user configuration data
+     */
+    getAccessUsersByUserid(requestParameters: AccessUsersApiGetAccessUsersByUseridRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersGetAccessUsersByUseridResponse>;
+    /**
+     * Creates request options for getAccessUsersByUseridTokenByTokenName without sending the request
+     */
+    getAccessUsersByUseridTokenByTokenNameRequestOpts(requestParameters: AccessUsersApiGetAccessUsersByUseridTokenByTokenNameRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read user\'s API token metadata
+     * Read user\'s API token metadata
+     */
+    getAccessUsersByUseridTokenByTokenNameRaw(requestParameters: AccessUsersApiGetAccessUsersByUseridTokenByTokenNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersGetAccessUsersByUseridTokenByTokenNameResponse>>;
+    /**
+     * Read user\'s API token metadata
+     * Read user\'s API token metadata
+     */
+    getAccessUsersByUseridTokenByTokenName(requestParameters: AccessUsersApiGetAccessUsersByUseridTokenByTokenNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersGetAccessUsersByUseridTokenByTokenNameResponse>;
+    /**
+     * Creates request options for getToken without sending the request
+     */
+    getTokenRequestOpts(requestParameters: AccessUsersApiGetTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List user\'s API tokens
+     * List user\'s API tokens
+     */
+    getTokenRaw(requestParameters: AccessUsersApiGetTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersGetTokenResponse>>;
+    /**
+     * List user\'s API tokens
+     * List user\'s API tokens
+     */
+    getToken(requestParameters: AccessUsersApiGetTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersGetTokenResponse>;
+    /**
+     * Creates request options for getUsers without sending the request
+     */
+    getUsersRequestOpts(requestParameters: AccessUsersApiGetUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List users  Permissions: Returns all or just the logged-in user (/API token owner), depending on privileges.
+     * List users
+     */
+    getUsersRaw(requestParameters: AccessUsersApiGetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersGetUsersResponse>>;
+    /**
+     * List users  Permissions: Returns all or just the logged-in user (/API token owner), depending on privileges.
+     * List users
+     */
+    getUsers(requestParameters?: AccessUsersApiGetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersGetUsersResponse>;
+    /**
+     * Creates request options for updateToken without sending the request
+     */
+    updateTokenRequestOpts(requestParameters: AccessUsersApiUpdateTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update user\'s API token metadata
+     * Update user\'s API token metadata
+     */
+    updateTokenRaw(requestParameters: AccessUsersApiUpdateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersUpdateTokenResponse>>;
+    /**
+     * Update user\'s API token metadata
+     * Update user\'s API token metadata
+     */
+    updateToken(requestParameters: AccessUsersApiUpdateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersUpdateTokenResponse>;
+    /**
+     * Creates request options for updateUnlockTfa without sending the request
+     */
+    updateUnlockTfaRequestOpts(requestParameters: AccessUsersApiUpdateUnlockTfaRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unlock a user\'s TFA authentication.
+     * Unlock a user\'s TFA authentication
+     */
+    updateUnlockTfaRaw(requestParameters: AccessUsersApiUpdateUnlockTfaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersUpdateUnlockTfaResponse>>;
+    /**
+     * Unlock a user\'s TFA authentication.
+     * Unlock a user\'s TFA authentication
+     */
+    updateUnlockTfa(requestParameters: AccessUsersApiUpdateUnlockTfaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersUpdateUnlockTfaResponse>;
+    /**
+     * Creates request options for updateUsers without sending the request
+     */
+    updateUsersRequestOpts(requestParameters: AccessUsersApiUpdateUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update user configuration. To change a user\'s password use the \'PUT /access/password\' endpoint.
+     * Update user configuration
+     */
+    updateUsersRaw(requestParameters: AccessUsersApiUpdateUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessUsersUpdateUsersResponse>>;
+    /**
+     * Update user configuration. To change a user\'s password use the \'PUT /access/password\' endpoint.
+     * Update user configuration
+     */
+    updateUsers(requestParameters: AccessUsersApiUpdateUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessUsersUpdateUsersResponse>;
+}