@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta3/token/Token.d.mts

@@ -0,0 +1,543 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/identity/tokens": {
+        /** Retrieves tokens associated with the authenticated user. */
+        get: operations["getUserTokens"];
+        /** Generates a token for the authenticated user. */
+        post: operations["generateToken"];
+        /** Deletes a specific token for the authenticated user. */
+        delete: operations["deleteUserToken"];
+    };
+    "/api/identity/tokens/{tokenId}": {
+        /** Retrieves a specific token by its ID. */
+        get: operations["getUserTokensById"];
+    };
+    "/api/identity/tokens/infinite": {
+        /** Creates a non-expiring user token for provider admin use cases. */
+        get: operations["issueIndefiniteLifetimeToken"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Represents a user-owned API token or OAuth session. */
+        UserToken: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the token.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description UUID of the user who owns the token.
+             */
+            userId: string;
+            /** @description Authentication provider associated with the token. */
+            provider: string;
+            /** @description Access token value. */
+            accessToken?: string;
+            /** @description Refresh token value when applicable. */
+            refreshToken?: string;
+            /** @description Human-readable token name. */
+            name?: string;
+            /** @description Purpose for which the token was created. */
+            purpose?: string;
+            /** @description Whether this entry represents an OAuth session. */
+            isOauth?: boolean;
+            /**
+             * Format: date-time
+             * @description Timestamp when the token was created.
+             */
+            createdAt?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the token was last updated.
+             */
+            updatedAt?: string;
+        };
+        /** @description A paginated list of tokens. */
+        TokenPage: {
+            /** @description Tokens returned on the current page. */
+            tokens: {
+                /**
+                 * Format: uuid
+                 * @description Unique identifier for the token.
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description UUID of the user who owns the token.
+                 */
+                userId: string;
+                /** @description Authentication provider associated with the token. */
+                provider: string;
+                /** @description Access token value. */
+                accessToken?: string;
+                /** @description Refresh token value when applicable. */
+                refreshToken?: string;
+                /** @description Human-readable token name. */
+                name?: string;
+                /** @description Purpose for which the token was created. */
+                purpose?: string;
+                /** @description Whether this entry represents an OAuth session. */
+                isOauth?: boolean;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the token was created.
+                 */
+                createdAt?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the token was last updated.
+                 */
+                updatedAt?: string;
+            }[];
+            /** @description Total number of tokens across all pages. */
+            totalCount: number;
+            /** @description Current page number (zero-based). */
+            page: number;
+            /** @description Number of tokens per page. */
+            pageSize: number;
+        };
+    };
+    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 Token ID */
+        tokenId: string;
+        /** @description ID of the token to delete. */
+        tokenIdQuery: string;
+        /** @description UUID of the user to issue the indefinite token for. */
+        userIdQuery: string;
+        /** @description Authentication provider to associate with the indefinite token. */
+        providerQuery: 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;
+        /** @description Whether to retrieve OAuth-backed sessions instead of API tokens. */
+        isOauth: boolean;
+        /** @description Name of the token. */
+        name: string;
+        /** @description Purpose for which the token is generated. */
+        purpose: string;
+    };
+}
+interface operations {
+    /** Retrieves tokens associated with the authenticated user. */
+    getUserTokens: {
+        parameters: {
+            query: {
+                /** Whether to retrieve OAuth-backed sessions instead of API tokens. */
+                isOauth?: boolean;
+                /** 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: {
+            /** Tokens response */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Tokens returned on the current page. */
+                        tokens: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the token.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user who owns the token.
+                             */
+                            userId: string;
+                            /** @description Authentication provider associated with the token. */
+                            provider: string;
+                            /** @description Access token value. */
+                            accessToken?: string;
+                            /** @description Refresh token value when applicable. */
+                            refreshToken?: string;
+                            /** @description Human-readable token name. */
+                            name?: string;
+                            /** @description Purpose for which the token was created. */
+                            purpose?: string;
+                            /** @description Whether this entry represents an OAuth session. */
+                            isOauth?: boolean;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was last updated.
+                             */
+                            updatedAt?: string;
+                        }[];
+                        /** @description Total number of tokens across all pages. */
+                        totalCount: number;
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of tokens per page. */
+                        pageSize: number;
+                    };
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Generates a token for the authenticated user. */
+    generateToken: {
+        parameters: {
+            query: {
+                /** Name of the token. */
+                name: string;
+                /** Purpose for which the token is generated. */
+                purpose?: string;
+            };
+        };
+        responses: {
+            /** Token generated */
+            201: {
+                content: {
+                    "application/json": {
+                        /** @description Tokens returned on the current page. */
+                        tokens: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the token.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user who owns the token.
+                             */
+                            userId: string;
+                            /** @description Authentication provider associated with the token. */
+                            provider: string;
+                            /** @description Access token value. */
+                            accessToken?: string;
+                            /** @description Refresh token value when applicable. */
+                            refreshToken?: string;
+                            /** @description Human-readable token name. */
+                            name?: string;
+                            /** @description Purpose for which the token was created. */
+                            purpose?: string;
+                            /** @description Whether this entry represents an OAuth session. */
+                            isOauth?: boolean;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was last updated.
+                             */
+                            updatedAt?: string;
+                        }[];
+                        /** @description Total number of tokens across all pages. */
+                        totalCount: number;
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of tokens per page. */
+                        pageSize: number;
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+    /** Deletes a specific token for the authenticated user. */
+    deleteUserToken: {
+        parameters: {
+            query: {
+                /** ID of the token to delete. */
+                tokenId: string;
+            };
+        };
+        responses: {
+            /** Token deleted */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Tokens returned on the current page. */
+                        tokens: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the token.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user who owns the token.
+                             */
+                            userId: string;
+                            /** @description Authentication provider associated with the token. */
+                            provider: string;
+                            /** @description Access token value. */
+                            accessToken?: string;
+                            /** @description Refresh token value when applicable. */
+                            refreshToken?: string;
+                            /** @description Human-readable token name. */
+                            name?: string;
+                            /** @description Purpose for which the token was created. */
+                            purpose?: string;
+                            /** @description Whether this entry represents an OAuth session. */
+                            isOauth?: boolean;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was last updated.
+                             */
+                            updatedAt?: string;
+                        }[];
+                        /** @description Total number of tokens across all pages. */
+                        totalCount: number;
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of tokens per page. */
+                        pageSize: number;
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+    /** Retrieves a specific token by its ID. */
+    getUserTokensById: {
+        parameters: {
+            path: {
+                /** Token ID */
+                tokenId: string;
+            };
+        };
+        responses: {
+            /** Token response */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the token.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the user who owns the token.
+                         */
+                        userId: string;
+                        /** @description Authentication provider associated with the token. */
+                        provider: string;
+                        /** @description Access token value. */
+                        accessToken?: string;
+                        /** @description Refresh token value when applicable. */
+                        refreshToken?: string;
+                        /** @description Human-readable token name. */
+                        name?: string;
+                        /** @description Purpose for which the token was created. */
+                        purpose?: string;
+                        /** @description Whether this entry represents an OAuth session. */
+                        isOauth?: boolean;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the token was created.
+                         */
+                        createdAt?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the token was last updated.
+                         */
+                        updatedAt?: 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;
+                };
+            };
+        };
+    };
+    /** Creates a non-expiring user token for provider admin use cases. */
+    issueIndefiniteLifetimeToken: {
+        parameters: {
+            query: {
+                /** UUID of the user to issue the indefinite token for. */
+                userId: string;
+                /** Authentication provider to associate with the indefinite token. */
+                provider: string;
+            };
+        };
+        responses: {
+            /** Token generated */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Tokens returned on the current page. */
+                        tokens: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the token.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user who owns the token.
+                             */
+                            userId: string;
+                            /** @description Authentication provider associated with the token. */
+                            provider: string;
+                            /** @description Access token value. */
+                            accessToken?: string;
+                            /** @description Refresh token value when applicable. */
+                            refreshToken?: string;
+                            /** @description Human-readable token name. */
+                            name?: string;
+                            /** @description Purpose for which the token was created. */
+                            purpose?: string;
+                            /** @description Whether this entry represents an OAuth session. */
+                            isOauth?: boolean;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the token was last updated.
+                             */
+                            updatedAt?: string;
+                        }[];
+                        /** @description Total number of tokens across all pages. */
+                        totalCount: number;
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of tokens per page. */
+                        pageSize: number;
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };