@meshery/schemas 1.2.10 → 1.2.12

package/dist/constructs/v1beta2/role/Role.d.ts

@@ -1,751 +0,0 @@
-/**
- * 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/{roleId}": {
-        /** 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 a role for the specified organization. */
-        post: operations["upsertRole"];
-    };
-    "/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. */
-            roleName: string;
-            /** @description Human-readable description of the role. */
-            description: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the role was created.
-             */
-            createdAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the role was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the role was soft-deleted, if applicable.
-             */
-            deletedAt?: string;
-        };
-        /** @description Payload for upserting a role. Includes only client-settable fields. */
-        RolePayload: {
-            /**
-             * 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. */
-            roleName: string;
-            /** @description Human-readable description of the role. */
-            description: string;
-        };
-        /** @description A paginated list of roles. */
-        RolesPage: {
-            /** @description Current page number (zero-based). */
-            page: number;
-            /** @description Number of roles per page. */
-            pageSize: number;
-            /** @description Total number of roles across all pages. */
-            totalCount: number;
-            /** @description The roles of the rolespage. */
-            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. */
-                roleName: string;
-                /** @description Human-readable description of the role. */
-                description: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the role was created.
-                 */
-                createdAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the role was last updated.
-                 */
-                updatedAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the role was soft-deleted, if applicable.
-                 */
-                deletedAt?: 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.
-             */
-            keychainId: string;
-            /**
-             * Format: uuid
-             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
-             */
-            roleId: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was created.
-             */
-            createdAt: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was last updated.
-             */
-            updatedAt: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was soft-deleted, if applicable.
-             */
-            deletedAt?: 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. */
-            roleNames: 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.
-             */
-            userId?: string;
-            /** @description The username of the user. */
-            username?: string;
-            /**
-             * Format: email
-             * @description Email address of the user.
-             */
-            email?: string;
-            /** @description First name of the user. */
-            firstName?: string;
-            /** @description Last name of the user. */
-            lastName?: string;
-            /** @description Current status of the user. */
-            status?: string;
-            /** @description Role names currently or newly assigned to the user. */
-            roleNames?: string[];
-            /**
-             * Format: date-time
-             * @description Timestamp when the user was created.
-             */
-            createdAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the user was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the user was soft-deleted, if applicable.
-             */
-            deletedAt?: string;
-        };
-        /** @description User notification preferences. */
-        Preference: {
-            /** @description Whether to send a welcome email to new users. */
-            welcomeEmail: boolean;
-            /** @description Whether to notify the user of role changes. */
-            notifyRoleChange: 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 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 page size */
-        pageSize: string;
-        /** @description Get responses that match search param value */
-        search: string;
-        /** @description Get ordered responses */
-        order: string;
-        /** @description Get all possible entries */
-        all: boolean;
-        /** @description Role grouping selector such as provider, organization, or team. */
-        selector: string;
-        /** @description Team ID used when selector is team. */
-        teamIdQuery: string;
-    };
-}
-interface operations {
-    /** Assigns a role to a user identified by email. */
-    addRoleHolder: {
-        responses: {
-            /** Role holder added */
-            201: 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. */
-                    roleNames: string[];
-                };
-            };
-        };
-    };
-    /** Removes a role assignment by ID. */
-    deleteRole: {
-        parameters: {
-            path: {
-                /** Role ID */
-                roleId: string;
-            };
-        };
-        responses: {
-            /** Role deleted */
-            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 page size */
-                pageSize?: string;
-                /** Get responses that match search param value */
-                search?: string;
-                /** Get ordered responses */
-                order?: string;
-                /** Get all possible entries */
-                all?: boolean;
-                /** Role grouping selector such as provider, organization, or team. */
-                selector?: string;
-                /** Team ID used when selector is team. */
-                teamId?: string;
-            };
-        };
-        responses: {
-            /** Roles response */
-            200: {
-                content: {
-                    "application/json": {
-                        /** @description Current page number (zero-based). */
-                        page: number;
-                        /** @description Number of roles per page. */
-                        pageSize: number;
-                        /** @description Total number of roles across all pages. */
-                        totalCount: number;
-                        /** @description The roles of the rolespage. */
-                        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. */
-                            roleName: string;
-                            /** @description Human-readable description of the role. */
-                            description: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the role was created.
-                             */
-                            createdAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the role was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the role was soft-deleted, if applicable.
-                             */
-                            deletedAt?: 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;
-                };
-            };
-        };
-    };
-    /** Updates role assignments for multiple users in the organization. */
-    bulkEditRoleHolder: {
-        parameters: {
-            path: {
-                /** Organization ID */
-                orgId: string;
-            };
-        };
-        responses: {
-            /** Role holders updated */
-            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;
-                };
-            };
-            /** Result not found */
-            404: {
-                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.
-                     */
-                    userId?: string;
-                    /** @description The username of the user. */
-                    username?: string;
-                    /**
-                     * Format: email
-                     * @description Email address of the user.
-                     */
-                    email?: string;
-                    /** @description First name of the user. */
-                    firstName?: string;
-                    /** @description Last name of the user. */
-                    lastName?: string;
-                    /** @description Current status of the user. */
-                    status?: string;
-                    /** @description Role names currently or newly assigned to the user. */
-                    roleNames?: string[];
-                    /**
-                     * Format: date-time
-                     * @description Timestamp when the user was created.
-                     */
-                    createdAt?: string;
-                    /**
-                     * Format: date-time
-                     * @description Timestamp when the user was last updated.
-                     */
-                    updatedAt?: string;
-                    /**
-                     * Format: date-time
-                     * @description Timestamp when the user was soft-deleted, if applicable.
-                     */
-                    deletedAt?: string;
-                }[];
-            };
-        };
-    };
-    /** Creates or updates a role for the specified organization. */
-    upsertRole: {
-        parameters: {
-            path: {
-                /** Organization ID */
-                orgId: string;
-            };
-        };
-        responses: {
-            /** Role upserted */
-            200: {
-                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. */
-                        roleName: string;
-                        /** @description Human-readable description of the role. */
-                        description: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the role was created.
-                         */
-                        createdAt?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the role was last updated.
-                         */
-                        updatedAt?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the role was soft-deleted, if applicable.
-                         */
-                        deletedAt?: string;
-                    };
-                };
-            };
-            /** 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;
-                };
-            };
-        };
-        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. */
-                    roleName: string;
-                    /** @description Human-readable description of the role. */
-                    description: string;
-                };
-            };
-        };
-    };
-    /** Returns all keychains assigned to the specified role. */
-    getRoleKeychains: {
-        parameters: {
-            path: {
-                /** Organization ID */
-                orgId: string;
-                /** Role ID */
-                roleId: string;
-            };
-            query: {
-                /** Get responses by page */
-                page?: string;
-                /** Get responses by page size */
-                pageSize?: string;
-                /** Get responses that match search param value */
-                search?: string;
-                /** Get ordered responses */
-                order?: string;
-            };
-        };
-        responses: {
-            /** Keychains response */
-            200: {
-                content: {
-                    "application/json": {
-                        page: number;
-                        page_size: number;
-                        total_count: number;
-                        /** @description The keychains of the keychainpage. */
-                        keychains: {
-                            /**
-                             * Format: uuid
-                             * @description Unique identifier for the keychain.
-                             */
-                            id: string;
-                            /** @description Name of the keychain. */
-                            name: string;
-                            /**
-                             * Format: uuid
-                             * @description Owner of the keychain.
-                             */
-                            owner: 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;
-                            /**
-                             * Format: date-time
-                             * @description SQL null Timestamp to handle null values of time.
-                             */
-                            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;
-                };
-            };
-            /** Result not found */
-            404: {
-                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 */
-            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;
-                };
-            };
-            /** Result not found */
-            404: {
-                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 */
-            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 };