@meshery/schemas 0.8.127 → 0.8.129

package/dist/constructs/v1beta1/role/Role.d.mts

@@ -0,0 +1,614 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/identity/roles": {
+        /** Assigns a role to a user identified by email. */
+        post: operations["addRoleHolder"];
+    };
+    "/api/identity/roles/{id}": {
+        /** Removes a role assignment by ID. */
+        delete: operations["deleteRole"];
+    };
+    "/api/identity/orgs/{orgID}/roles": {
+        /** Returns all roles defined for the specified organization. */
+        get: operations["getAllRoles"];
+        /** Updates role assignments for multiple users in the organization. */
+        put: operations["bulkEditRoleHolder"];
+        /** Creates or updates roles for the specified organization. */
+        post: operations["upsertRoles"];
+    };
+    "/api/identity/orgs/{orgID}/roles/{roleID}/keychains": {
+        /** Returns all keychains assigned to the specified role. */
+        get: operations["getRoleKeychains"];
+    };
+    "/api/identity/orgs/{orgID}/roles/{roleID}/keychains/{keychainID}": {
+        /** Associates a keychain with the specified role. */
+        post: operations["assignKeychainToRole"];
+        /** Removes the association between a keychain and a role. */
+        delete: operations["unassignKeychainFromRole"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Role definition for Layer5 Cloud (Meshery). */
+        Role: {
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            id?: string;
+            /** @description Unique name of the role. */
+            role_name: string;
+            /** @description Human-readable description of the role. */
+            description: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /** @description Timestamp when the role was soft-deleted. */
+            deleted_at?: string;
+        };
+        /** @description A paginated list of roles. */
+        RolesPage: {
+            /** @description Current page number (zero-based). */
+            page: number;
+            /** @description Number of roles per page. */
+            page_size: number;
+            /** @description Total number of roles across all pages. */
+            total_count: number;
+            roles: {
+                /**
+                 * Format: uuid
+                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                 */
+                id?: string;
+                /** @description Unique name of the role. */
+                role_name: string;
+                /** @description Human-readable description of the role. */
+                description: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the resource was created.
+                 */
+                created_at?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the resource was updated.
+                 */
+                updated_at?: string;
+                /** @description Timestamp when the role was soft-deleted. */
+                deleted_at?: string;
+            }[];
+        };
+        /** @description Mapping between a role and a keychain. */
+        RolesKeychainsMapping: {
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            keychain_id: string;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            role_id: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at: string;
+            /** @description SQL null Timestamp to handle null values of time. */
+            deleted_at?: string;
+        };
+        /** @description Request body for assigning a role to a user. */
+        RoleHolderRequest: {
+            /**
+             * Format: email
+             * @description Email of the user to assign roles to.
+             */
+            email: string;
+            /** @description List of role names to assign. */
+            role_names: string[];
+        };
+        /** @description Request to update role assignments for a user. */
+        UserRoleUpdateRequest: {
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            id?: string;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            user_id?: string;
+            username?: string;
+            /** Format: email */
+            email?: string;
+            first_name?: string;
+            last_name?: string;
+            status?: string;
+            role_names?: string[];
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+            /** @description SQL null Timestamp to handle null values of time. */
+            deleted_at?: string;
+        };
+        /** @description User notification preferences. */
+        Preference: {
+            /** @description Whether to send a welcome email to new users. */
+            welcome_email: boolean;
+            /** @description Whether to notify the user of role changes. */
+            notify_role_change: boolean;
+        };
+    };
+    responses: {
+        /** Invalid request body or request param */
+        400: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Expired JWT token used or insufficient privilege */
+        401: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Result not found */
+        404: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Internal server error */
+        500: {
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description Role ID */
+        id: string;
+        /** @description Organization ID */
+        orgID: string;
+        /** @description Role ID */
+        roleID: string;
+        /** @description Keychain ID */
+        keychainID: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+    };
+}
+interface operations {
+    /** Assigns a role to a user identified by email. */
+    addRoleHolder: {
+        responses: {
+            /** Role holder added successfully */
+            200: unknown;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: email
+                     * @description Email of the user to assign roles to.
+                     */
+                    email: string;
+                    /** @description List of role names to assign. */
+                    role_names: string[];
+                };
+            };
+        };
+    };
+    /** Removes a role assignment by ID. */
+    deleteRole: {
+        parameters: {
+            path: {
+                /** Role ID */
+                id: string;
+            };
+        };
+        responses: {
+            /** Role deleted successfully */
+            204: never;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Returns all roles defined for the specified organization. */
+    getAllRoles: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+            };
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+            };
+        };
+        responses: {
+            /** Roles fetched successfully */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of roles per page. */
+                        page_size: number;
+                        /** @description Total number of roles across all pages. */
+                        total_count: number;
+                        roles: {
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            id?: string;
+                            /** @description Unique name of the role. */
+                            role_name: string;
+                            /** @description Human-readable description of the role. */
+                            description: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was created.
+                             */
+                            created_at?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was updated.
+                             */
+                            updated_at?: string;
+                            /** @description Timestamp when the role was soft-deleted. */
+                            deleted_at?: string;
+                        }[];
+                    };
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Updates role assignments for multiple users in the organization. */
+    bulkEditRoleHolder: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+            };
+        };
+        responses: {
+            /** Role holders updated successfully */
+            200: unknown;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    id?: string;
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    user_id?: string;
+                    username?: string;
+                    /** Format: email */
+                    email?: string;
+                    first_name?: string;
+                    last_name?: string;
+                    status?: string;
+                    role_names?: string[];
+                    /** Format: date-time */
+                    created_at?: string;
+                    /** Format: date-time */
+                    updated_at?: string;
+                    /** @description SQL null Timestamp to handle null values of time. */
+                    deleted_at?: string;
+                }[];
+            };
+        };
+    };
+    /** Creates or updates roles for the specified organization. */
+    upsertRoles: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+            };
+        };
+        responses: {
+            /** Roles upserted successfully */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of roles per page. */
+                        page_size: number;
+                        /** @description Total number of roles across all pages. */
+                        total_count: number;
+                        roles: {
+                            /**
+                             * Format: uuid
+                             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                             */
+                            id?: string;
+                            /** @description Unique name of the role. */
+                            role_name: string;
+                            /** @description Human-readable description of the role. */
+                            description: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was created.
+                             */
+                            created_at?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was updated.
+                             */
+                            updated_at?: string;
+                            /** @description Timestamp when the role was soft-deleted. */
+                            deleted_at?: string;
+                        }[];
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    id?: string;
+                    /** @description Unique name of the role. */
+                    role_name: string;
+                    /** @description Human-readable description of the role. */
+                    description: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was created.
+                     */
+                    created_at?: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was updated.
+                     */
+                    updated_at?: string;
+                    /** @description Timestamp when the role was soft-deleted. */
+                    deleted_at?: string;
+                }[];
+            };
+        };
+    };
+    /** Returns all keychains assigned to the specified role. */
+    getRoleKeychains: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+                /** Role ID */
+                roleID: string;
+            };
+        };
+        responses: {
+            /** Keychains fetched successfully */
+            200: unknown;
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Associates a keychain with the specified role. */
+    assignKeychainToRole: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+                /** Role ID */
+                roleID: string;
+                /** Keychain ID */
+                keychainID: string;
+            };
+        };
+        responses: {
+            /** Keychain assigned to role successfully */
+            200: unknown;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Removes the association between a keychain and a role. */
+    unassignKeychainFromRole: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgID: string;
+                /** Role ID */
+                roleID: string;
+                /** Keychain ID */
+                keychainID: string;
+            };
+        };
+        responses: {
+            /** Keychain unassigned from role successfully */
+            204: never;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };