@meshery/schemas 1.3.30 → 1.3.32

package/dist/constructs/v1beta2/user/User.d.ts

@@ -24,26 +24,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/users": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get public users
-         * @description Returns publicly viewable user records.
-         */
-        get: operations["getUsers"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/identity/users/profile/{id}": {
         parameters: {
             query?: never;
@@ -524,7 +504,7 @@ export interface components {
              * Format: date-time
              * @description SQL null Timestamp to handle null values of time.
              */
-            deletedAt?: string;
+            deletedAt?: string | null;
         };
         /** @description An organization the user is a member of, together with the names of the roles assigned to that user within the organization. Returned as an item of User.organizations.organizationsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration). */
         OrganizationWithRoles: {
@@ -873,7 +853,10 @@ export interface components {
                 };
             }[];
         };
-        /** @description Paginated list of public user records */
+        /**
+         * @deprecated
+         * @description Deprecated: the public users directory (/api/users, getUsers) is documented by the v1beta3 user construct's PublicUsersPage, which reflects the reduced projection actually served since the directory was hardened. This full-User page shape was never what the endpoint returned post-hardening and is retained only for compatibility with existing type imports.
+         */
         UsersPageForNonAdmin: {
             /** @description Current page number of the result set. */
             page?: number;
@@ -1912,333 +1895,6 @@ export interface operations {
             };
         };
     };
-    getUsers: {
-        parameters: {
-            query?: {
-                /** @description Get responses by page */
-                page?: number;
-                /** @description Get responses by page size */
-                pageSize?: number;
-                /** @description Get responses that match search param value */
-                search?: string;
-                /** @description Get ordered responses */
-                order?: string;
-                /** @description Get filtered reponses */
-                filter?: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Paginated list of public users */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /** @description Current page number of the result set. */
-                        page?: number;
-                        /** @description Number of items per page. */
-                        pageSize?: number;
-                        /** @description Total number of items available. */
-                        totalCount?: number;
-                        /** @description The data of the userspagefornonadmin. */
-                        data?: {
-                            /**
-                             * Format: uuid
-                             * @description Unique identifier for the user
-                             */
-                            id: string;
-                            /**
-                             * @deprecated
-                             * @description Legacy IdP-derived identifier. Removed in v1beta3; resolve users by id or email.
-                             */
-                            userId: string;
-                            /**
-                             * @description Authentication provider (e.g., Google, Github)
-                             * @example [
-                             *       "local",
-                             *       "github",
-                             *       "google",
-                             *       "twitter"
-                             *     ]
-                             */
-                            provider: string;
-                            /**
-                             * Format: email
-                             * @description User's email address
-                             */
-                            email: string;
-                            /** @description User's first name */
-                            firstName: string;
-                            /** @description User's last name */
-                            lastName: string;
-                            /**
-                             * Format: uri
-                             * @description URL to user's avatar image
-                             */
-                            avatarUrl?: string;
-                            /**
-                             * @description User account status
-                             * @enum {string}
-                             */
-                            status: "active" | "inactive" | "pending" | "anonymous";
-                            /**
-                             * @description User's biography or description
-                             * @default
-                             */
-                            bio: string;
-                            /** @description User's country information stored as JSONB */
-                            country?: {
-                                [key: string]: unknown;
-                            };
-                            /** @description User's region information stored as JSONB */
-                            region?: {
-                                [key: string]: unknown;
-                            };
-                            /** @description User preferences stored as JSONB */
-                            preferences?: {
-                                /** @description The mesh adapters of the preference. */
-                                meshAdapters?: Record<string, never>[];
-                                grafana?: {
-                                    /** @description Grafana URL for the user configuration. */
-                                    grafanaUrl?: string;
-                                    /** @description Grafana API key for the user configuration. */
-                                    grafanaApiKey?: string;
-                                    /** @description Selected Grafana board configurations for the user. */
-                                    selectedBoardsConfigs?: {
-                                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
-                                        board?: Record<string, never>;
-                                        /** @description Panels selected for the Grafana board configuration. */
-                                        panels?: Record<string, never>[];
-                                        /** @description Template variables applied to the selected Grafana board configuration. */
-                                        templateVars?: string[];
-                                    }[];
-                                };
-                                prometheus?: {
-                                    /** @description The prometheus URL of the prometheus. */
-                                    prometheusUrl?: string;
-                                    /** @description The selected prometheus boards configs of the prometheus. */
-                                    selectedPrometheusBoardsConfigs?: {
-                                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
-                                        board?: Record<string, never>;
-                                        /** @description Panels selected for the Grafana board configuration. */
-                                        panels?: Record<string, never>[];
-                                        /** @description Template variables applied to the selected Grafana board configuration. */
-                                        templateVars?: string[];
-                                    }[];
-                                };
-                                loadTestPrefs?: {
-                                    /** @description Concurrent requests */
-                                    c?: number;
-                                    /** @description Queries per second */
-                                    qps?: number;
-                                    /** @description Duration */
-                                    t?: string;
-                                    /** @description Load generator */
-                                    gen?: string;
-                                };
-                                /** @description The anonymous usage stats of the preference. */
-                                anonymousUsageStats: boolean;
-                                /** @description The anonymous perf results of the preference. */
-                                anonymousPerfResults: boolean;
-                                /**
-                                 * Format: date-time
-                                 * @description Timestamp of when the resource was last updated.
-                                 */
-                                updatedAt: string;
-                                /** @description The dashboard preferences of the preference. */
-                                dashboardPreferences: {
-                                    [key: string]: unknown;
-                                };
-                                /**
-                                 * Format: uuid
-                                 * @description ID of the associated selectedOrganization.
-                                 */
-                                selectedOrganizationId: string;
-                                /** @description The selected workspace for organizations of the preference. */
-                                selectedWorkspaceForOrganizations: {
-                                    [key: string]: string;
-                                };
-                                /** @description The users extension preferences of the preference. */
-                                usersExtensionPreferences: {
-                                    [key: string]: unknown;
-                                };
-                                /** @description The remote provider preferences of the preference. */
-                                remoteProviderPreferences: {
-                                    [key: string]: unknown;
-                                };
-                            };
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when user accepted terms and conditions
-                             */
-                            acceptedTermsAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp of user's first login
-                             */
-                            firstLoginTime?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp of user's most recent login
-                             */
-                            lastLoginTime: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the user record was created
-                             */
-                            createdAt: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the user record was last updated
-                             */
-                            updatedAt: string;
-                            /** @description Various online profiles associated with the user account */
-                            socials?: {
-                                /** @description The site of the social. */
-                                site: string;
-                                /**
-                                 * Format: uri
-                                 * @description The link of the social.
-                                 */
-                                link: string;
-                            }[];
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the user record was soft-deleted (null if not deleted)
-                             */
-                            deletedAt: string | null;
-                            /**
-                             * @description Names of the global roles assigned to the user. Free-form, user-generated values sourced from the roles table (role_name is a varchar, not a fixed enumeration); the seeded system roles such as "admin", "organization admin" and "user" are a subset, not the whole set.
-                             * @example [
-                             *       "organization admin",
-                             *       "user"
-                             *     ]
-                             */
-                            roleNames?: string[];
-                            /** @description Teams the user belongs to with role information */
-                            teams?: {
-                                /** @description Team memberships for the user with their assigned roles. */
-                                teamsWithRoles?: {
-                                    /**
-                                     * Format: uuid
-                                     * @description Unique identifier of the team.
-                                     */
-                                    id: string;
-                                    /** @description Name of the team. */
-                                    name: string;
-                                    /** @description Human readable description of the team. */
-                                    description?: string;
-                                    /**
-                                     * Format: uuid
-                                     * @description Identifier of the team owner.
-                                     */
-                                    owner?: string;
-                                    /** @description Free-form metadata associated with the team. */
-                                    metadata?: {
-                                        [key: string]: unknown;
-                                    };
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the team was created.
-                                     */
-                                    createdAt?: string;
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the team was last updated.
-                                     */
-                                    updatedAt?: string;
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the team was soft-deleted (null if not deleted).
-                                     */
-                                    deletedAt?: string | null;
-                                    /** @description Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
-                                    roleNames: string[];
-                                }[];
-                                /** @description Total number of team memberships returned for the user. */
-                                totalCount?: number;
-                            };
-                            /** @description Organizations the user belongs to with role information */
-                            organizations?: {
-                                /** @description Organization memberships for the user with their assigned roles. */
-                                organizationsWithRoles?: {
-                                    /**
-                                     * Format: uuid
-                                     * @description Unique identifier of the organization.
-                                     */
-                                    id: string;
-                                    /** @description Name of the organization. */
-                                    name: string;
-                                    /** @description Human readable description of the organization. */
-                                    description?: string;
-                                    /** @description Country associated with the organization. */
-                                    country?: string;
-                                    /** @description Region associated with the organization. */
-                                    region?: string;
-                                    /**
-                                     * Format: uuid
-                                     * @description Identifier of the organization owner.
-                                     */
-                                    owner?: string;
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the organization was created.
-                                     */
-                                    createdAt?: string;
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the organization was last updated.
-                                     */
-                                    updatedAt?: string;
-                                    /**
-                                     * Format: date-time
-                                     * @description Timestamp when the organization was soft-deleted (null if not deleted).
-                                     */
-                                    deletedAt?: string | null;
-                                    /** @description Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
-                                    roleNames: string[];
-                                }[];
-                                /** @description Total number of organization memberships returned for the user. */
-                                totalCount?: number;
-                            };
-                        }[];
-                    };
-                };
-            };
-            /** @description Invalid request body or request param */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** @description Expired JWT token used or insufficient privilege */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** @description Internal server error */
-            500: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-    };
     getUserProfileById: {
         parameters: {
             query?: never;
@@ -3472,7 +3128,7 @@ export interface operations {
                          * Format: date-time
                          * @description SQL null Timestamp to handle null values of time.
                          */
-                        deletedAt?: string;
+                        deletedAt?: string | null;
                     }[];
                 };
             };