{ "openapi": "3.1.0", "info": { "title": "scope.kz API", "version": "0.1.0" }, "paths": { "/health/live": { "get": { "summary": "Health Live", "operationId": "health_live_health_live_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/health/ready": { "get": { "summary": "Health Ready", "operationId": "health_ready_health_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "description": "Stage 1: verify the password. By default 2FA is mandatory \u2192 returns a\nshort-lived pending token that authorizes only /auth/2fa/verify.\n\nIf the org policy has 2FA disabled (super_admin toggle), the full session\ntoken is issued here directly (no 2FA step) for every role.", "operationId": "login_api_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/2fa/verify": { "post": { "tags": [ "auth" ], "summary": "Verify 2Fa", "description": "Stage 2: confirm the TOTP code (or enroll on first login), then issue the\nfull session token. A recovery code is accepted in place of a TOTP code.", "operationId": "verify_2fa_api_auth_2fa_verify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwoFactorVerifyRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/me": { "get": { "tags": [ "auth" ], "summary": "Me", "operationId": "me_api_auth_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPublic" } } } } } } }, "/api/auth/session": { "get": { "tags": [ "auth" ], "summary": "Session Info", "description": "Effective idle window for the caller \u2014 the client sizes its logout timer.", "operationId": "session_info_api_auth_session_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/refresh": { "post": { "tags": [ "auth" ], "summary": "Refresh", "description": "Slide the session: re-issue a token with a fresh idle window, preserving\nthe jti so the session vault entry survives. Called by the client on activity.", "operationId": "refresh_api_auth_refresh_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshResponse" } } } } } } }, "/api/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Logout", "operationId": "logout_api_auth_logout_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/change-password": { "post": { "tags": [ "auth" ], "summary": "Change Password", "operationId": "change_password_api_auth_change_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/users": { "get": { "tags": [ "users" ], "summary": "List Users", "operationId": "list_users_api_users_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/UserPublic" }, "type": "array", "title": "Response List Users Api Users Get" } } } } } }, "post": { "tags": [ "users" ], "summary": "Create User", "operationId": "create_user_api_users_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/users/{user_id}/access": { "get": { "tags": [ "users" ], "summary": "List User Access", "description": "A single user's server-access grants \u2014 used to prefill the Edit User\nselector without N per-server requests.", "operationId": "list_user_access_api_users__user_id__access_get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionPublic" }, "title": "Response List User Access Api Users User Id Access Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/users/active": { "get": { "tags": [ "users" ], "summary": "List Active Users", "operationId": "list_active_users_api_users_active_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ActiveUserEntry" }, "type": "array", "title": "Response List Active Users Api Users Active Get" } } } } } } }, "/api/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get User", "operationId": "get_user_api_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Update User", "operationId": "update_user_api_users__user_id__patch", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/dashboard/overview": { "get": { "tags": [ "dashboard" ], "summary": "Dashboard Overview", "operationId": "dashboard_overview_api_dashboard_overview_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardOverview" } } } } } } }, "/api/dashboard/activity": { "get": { "tags": [ "dashboard" ], "summary": "Dashboard Activity", "description": "Connection-activity heatmap (last 7 days \u00d7 24 hours) from session starts.", "operationId": "dashboard_activity_api_dashboard_activity_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityHeatmap" } } } } } } }, "/api/dashboard/host-metrics": { "get": { "tags": [ "dashboard" ], "summary": "Dashboard Host Metrics", "description": "Live host metrics for the dashboard widget (polled by the client).", "operationId": "dashboard_host_metrics_api_dashboard_host_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/resources": { "get": { "tags": [ "resources" ], "summary": "List Resources", "operationId": "list_resources_api_resources_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResourcePublic" }, "type": "array", "title": "Response List Resources Api Resources Get" } } } } } }, "post": { "tags": [ "resources" ], "summary": "Create Resource", "operationId": "create_resource_api_resources_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourcePublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/permissions": { "get": { "tags": [ "resources" ], "summary": "List Permissions", "operationId": "list_permissions_api_resources_permissions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PermissionPublic" }, "type": "array", "title": "Response List Permissions Api Resources Permissions Get" } } } } } }, "post": { "tags": [ "resources" ], "summary": "Grant Permission", "operationId": "grant_permission_api_resources_permissions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/permissions/{permission_id}": { "delete": { "tags": [ "resources" ], "summary": "Revoke Permission", "operationId": "revoke_permission_api_resources_permissions__permission_id__delete", "parameters": [ { "name": "permission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Permission Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionRevokeResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}": { "patch": { "tags": [ "resources" ], "summary": "Update Resource", "operationId": "update_resource_api_resources__resource_id__patch", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourcePublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "resources" ], "summary": "Delete Resource", "operationId": "delete_resource_api_resources__resource_id__delete", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/host-key": { "delete": { "tags": [ "resources" ], "summary": "Reset Host Key", "description": "Clear the pinned SSH host key so it is re-pinned on the next connect.\n\nUse after a legitimate server rekey. Under the strict policy the resource\nwill refuse connections until a key is pinned again.", "operationId": "reset_host_key_api_resources__resource_id__host_key_delete", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourcePublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/test": { "post": { "tags": [ "resources" ], "summary": "Test Resource Connection", "operationId": "test_resource_connection_api_resources__resource_id__test_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTestResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/readiness": { "post": { "tags": [ "resources" ], "summary": "Check Resource Readiness Preview", "description": "Check readiness before creating/updating a Windows RDP resource.", "operationId": "check_resource_readiness_preview_api_resources_readiness_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceReadinessResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/readiness": { "post": { "tags": [ "resources" ], "summary": "Check Existing Resource Readiness", "operationId": "check_existing_resource_readiness_api_resources__resource_id__readiness_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceReadinessResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/metrics": { "get": { "tags": [ "resources" ], "summary": "Resource Metrics", "description": "Live CPU/RAM/Disk/uptime for SSH/SFTP hosts (Connect metrics widget).\n\nReturns ``available: false`` for RDP/Windows or any connection failure \u2014\nthe widget falls back to placeholders.", "operationId": "resource_metrics_api_resources__resource_id__metrics_get", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceMetrics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/access-requests/catalog": { "get": { "tags": [ "access-requests" ], "summary": "List Catalog", "description": "Secret-free list of all resources a user can request access to.", "operationId": "list_catalog_api_access_requests_catalog_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResourceCatalogItem" }, "type": "array", "title": "Response List Catalog Api Access Requests Catalog Get" } } } } } } }, "/api/access-requests/pending-count": { "get": { "tags": [ "access-requests" ], "summary": "Pending Count", "operationId": "pending_count_api_access_requests_pending_count_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/access-requests": { "get": { "tags": [ "access-requests" ], "summary": "List Access Requests", "operationId": "list_access_requests_api_access_requests_get", "parameters": [ { "name": "request_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequestPublic" }, "title": "Response List Access Requests Api Access Requests Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "access-requests" ], "summary": "Create Access Request", "operationId": "create_access_request_api_access_requests_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/access-requests/{request_id}/approve": { "post": { "tags": [ "access-requests" ], "summary": "Approve Access Request", "operationId": "approve_access_request_api_access_requests__request_id__approve_post", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestApprove" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/access-requests/{request_id}/deny": { "post": { "tags": [ "access-requests" ], "summary": "Deny Access Request", "operationId": "deny_access_request_api_access_requests__request_id__deny_post", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestDeny" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/access-requests/{request_id}/cancel": { "post": { "tags": [ "access-requests" ], "summary": "Cancel Access Request", "operationId": "cancel_access_request_api_access_requests__request_id__cancel_post", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRequestPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/groups": { "get": { "tags": [ "groups" ], "summary": "List Groups", "operationId": "list_groups_api_groups_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GroupPublic" }, "type": "array", "title": "Response List Groups Api Groups Get" } } } } } }, "post": { "tags": [ "groups" ], "summary": "Create Group", "operationId": "create_group_api_groups_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/groups/{group_id}": { "patch": { "tags": [ "groups" ], "summary": "Rename Group", "operationId": "rename_group_api_groups__group_id__patch", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "groups" ], "summary": "Delete Group", "operationId": "delete_group_api_groups__group_id__delete", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions": { "post": { "tags": [ "sessions" ], "summary": "Create Session", "operationId": "create_session_api_sessions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/active": { "get": { "tags": [ "sessions" ], "summary": "List Active Sessions", "operationId": "list_active_sessions_api_sessions_active_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ActiveSessionEntry" }, "type": "array", "title": "Response List Active Sessions Api Sessions Active Get" } } } } } } }, "/api/sessions/{session_id}/disconnect": { "post": { "tags": [ "sessions" ], "summary": "Disconnect Session", "operationId": "disconnect_session_api_sessions__session_id__disconnect_post", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/{session_id}": { "get": { "tags": [ "sessions" ], "summary": "Get Session", "operationId": "get_session_api_sessions__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPublic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/ls": { "get": { "tags": [ "sftp" ], "summary": "Sftp List", "operationId": "sftp_list_api_resources__resource_id__sftp_ls_get", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "/", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SftpFileEntry" }, "title": "Response Sftp List Api Resources Resource Id Sftp Ls Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/mkdir": { "post": { "tags": [ "sftp" ], "summary": "Sftp Mkdir", "operationId": "sftp_mkdir_api_resources__resource_id__sftp_mkdir_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/file": { "delete": { "tags": [ "sftp" ], "summary": "Sftp Delete", "operationId": "sftp_delete_api_resources__resource_id__sftp_file_delete", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/rename": { "post": { "tags": [ "sftp" ], "summary": "Sftp Rename", "operationId": "sftp_rename_api_resources__resource_id__sftp_rename_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "src", "in": "query", "required": true, "schema": { "type": "string", "title": "Src" } }, { "name": "dst", "in": "query", "required": true, "schema": { "type": "string", "title": "Dst" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/download": { "get": { "tags": [ "sftp" ], "summary": "Sftp Download Route", "operationId": "sftp_download_route_api_resources__resource_id__sftp_download_get", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/sftp/upload": { "post": { "tags": [ "sftp" ], "summary": "Sftp Upload Route", "operationId": "sftp_upload_route_api_resources__resource_id__sftp_upload_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "/", "title": "Path" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_sftp_upload_route_api_resources__resource_id__sftp_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sftp/transfer": { "post": { "tags": [ "sftp" ], "summary": "Sftp Transfer", "operationId": "sftp_transfer_api_sftp_transfer_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SftpTransferRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/winrm/files": { "get": { "tags": [ "winrm-files" ], "summary": "Winrm List", "operationId": "winrm_list_api_resources__resource_id__winrm_files_get", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/winrm/files/download": { "get": { "tags": [ "winrm-files" ], "summary": "Winrm Download", "operationId": "winrm_download_api_resources__resource_id__winrm_files_download_get", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/resources/{resource_id}/winrm/files/upload": { "post": { "tags": [ "winrm-files" ], "summary": "Winrm Upload", "operationId": "winrm_upload_api_resources__resource_id__winrm_files_upload_post", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "description": "Target directory on the remote host", "title": "Path" }, "description": "Target directory on the remote host" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_winrm_upload_api_resources__resource_id__winrm_files_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/discovery/computers": { "post": { "tags": [ "discovery" ], "summary": "Discover", "operationId": "discover_api_discovery_computers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/discovery/import": { "post": { "tags": [ "discovery" ], "summary": "Import Computers", "operationId": "import_computers_api_discovery_import_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/discovery/setup-script": { "get": { "tags": [ "discovery" ], "summary": "Setup Script", "description": "One-time domain GPO/script for the sysadmin: enable WinRM and an RDP-logon\ngroup across the domain so imported hosts are connect-ready without per-host setup.", "operationId": "setup_script_api_discovery_setup_script_get", "parameters": [ { "name": "domain", "in": "query", "required": true, "schema": { "type": "string", "description": "AD domain, e.g. alatau.local", "title": "Domain" }, "description": "AD domain, e.g. alatau.local" }, { "name": "service_account", "in": "query", "required": false, "schema": { "type": "string", "description": "scope service account (sAMAccountName)", "default": "scope-svc", "title": "Service Account" }, "description": "scope service account (sAMAccountName)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/logs": { "get": { "tags": [ "audit" ], "summary": "Get Audit Logs", "operationId": "get_audit_logs_api_audit_logs_get", "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/logs/export": { "get": { "tags": [ "audit" ], "summary": "Export Audit Logs", "operationId": "export_audit_logs_api_audit_logs_export_get", "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "csv", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/recordings": { "get": { "tags": [ "audit" ], "summary": "Get Recordings", "operationId": "get_recordings_api_audit_recordings_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordingPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/recordings/{recording_id}/download": { "get": { "tags": [ "audit" ], "summary": "Download Recording", "operationId": "download_recording_api_audit_recordings__recording_id__download_get", "parameters": [ { "name": "recording_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Recording Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/recordings/{recording_id}": { "delete": { "tags": [ "audit" ], "summary": "Delete Recording", "operationId": "delete_recording_api_audit_recordings__recording_id__delete", "parameters": [ { "name": "recording_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Recording Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/sessions/{session_id}/screenshots": { "get": { "tags": [ "audit" ], "summary": "List Session Screenshots", "operationId": "list_session_screenshots_api_audit_sessions__session_id__screenshots_get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenshotEntry" }, "title": "Response List Session Screenshots Api Audit Sessions Session Id Screenshots Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/screenshots": { "get": { "tags": [ "audit" ], "summary": "List Screenshots", "description": "Recent connection screenshots across all sessions, enriched with\nuser / resource / protocol from the owning session.", "operationId": "list_screenshots_api_audit_screenshots_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 60, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenshotEntry" }, "title": "Response List Screenshots Api Audit Screenshots Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/screenshots/{screenshot_id}": { "get": { "tags": [ "audit" ], "summary": "Get Screenshot", "operationId": "get_screenshot_api_audit_screenshots__screenshot_id__get", "parameters": [ { "name": "screenshot_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Screenshot Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "audit" ], "summary": "Delete Screenshot", "operationId": "delete_screenshot_api_audit_screenshots__screenshot_id__delete", "parameters": [ { "name": "screenshot_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Screenshot Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/audit/screenshot": { "post": { "tags": [ "audit" ], "summary": "Upload Screenshot", "operationId": "upload_screenshot_api_audit_screenshot_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_screenshot_api_audit_screenshot_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alerts": { "get": { "tags": [ "alerts" ], "summary": "Get Alerts", "operationId": "get_alerts_api_alerts_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alerts/counts": { "get": { "tags": [ "alerts" ], "summary": "Get Alert Counts", "operationId": "get_alert_counts_api_alerts_counts_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertCounts" } } } } } } }, "/api/alerts/bulk-resolve": { "post": { "tags": [ "alerts" ], "summary": "Bulk Resolve Alerts", "operationId": "bulk_resolve_alerts_api_alerts_bulk_resolve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkResolve" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alerts/{alert_id}/ack": { "post": { "tags": [ "alerts" ], "summary": "Ack Alert", "operationId": "ack_alert_api_alerts__alert_id__ack_post", "parameters": [ { "name": "alert_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alert Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertEntry" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alerts/{alert_id}/resolve": { "post": { "tags": [ "alerts" ], "summary": "Resolve Alert Endpoint", "operationId": "resolve_alert_endpoint_api_alerts__alert_id__resolve_post", "parameters": [ { "name": "alert_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alert Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertEntry" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alerts/{alert_id}/mute": { "post": { "tags": [ "alerts" ], "summary": "Mute Alert Endpoint", "operationId": "mute_alert_endpoint_api_alerts__alert_id__mute_post", "parameters": [ { "name": "alert_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alert Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertAction", "default": { "minutes": 60 } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertEntry" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alert-rules": { "get": { "tags": [ "alert-rules" ], "summary": "Get Alert Rules", "operationId": "get_alert_rules_api_alert_rules_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AlertRule" }, "type": "array", "title": "Response Get Alert Rules Api Alert Rules Get" } } } } } }, "post": { "tags": [ "alert-rules" ], "summary": "Create Alert Rule", "operationId": "create_alert_rule_api_alert_rules_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/alert-rules/{rule_id}": { "patch": { "tags": [ "alert-rules" ], "summary": "Patch Alert Rule", "operationId": "patch_alert_rule_api_alert_rules__rule_id__patch", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Rule Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "alert-rules" ], "summary": "Delete Alert Rule", "operationId": "delete_alert_rule_api_alert_rules__rule_id__delete", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Rule Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/metrics/latest": { "get": { "tags": [ "metrics" ], "summary": "Latest Metrics", "description": "Most recent sample for each target (the scope.kz VM and every server).", "operationId": "latest_metrics_api_metrics_latest_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MetricSample" }, "type": "array", "title": "Response Latest Metrics Api Metrics Latest Get" } } } } } } }, "/api/metrics/history": { "get": { "tags": [ "metrics" ], "summary": "Metric History", "description": "Time-ordered samples for one target over the last N minutes.", "operationId": "metric_history_api_metrics_history_get", "parameters": [ { "name": "target", "in": "query", "required": true, "schema": { "type": "string", "title": "Target" } }, { "name": "minutes", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10080, "minimum": 1, "default": 60, "title": "Minutes" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 2000, "minimum": 1, "default": 500, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricSample" }, "title": "Response Metric History Api Metrics History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/notifications": { "get": { "tags": [ "notifications" ], "summary": "Get Notifications", "operationId": "get_notifications_api_notifications_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationConfig" } } } } } }, "put": { "tags": [ "notifications" ], "summary": "Update Notifications", "operationId": "update_notifications_api_notifications_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationConfig" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/notifications/test": { "post": { "tags": [ "notifications" ], "summary": "Test Notifications", "operationId": "test_notifications_api_notifications_test_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTestResult" } } } } } } }, "/api/profile": { "get": { "tags": [ "profile" ], "summary": "My Profile", "operationId": "my_profile_api_profile_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileSummary" } } } } } } }, "/api/profile/sessions": { "get": { "tags": [ "profile" ], "summary": "My Sessions", "operationId": "my_sessions_api_profile_sessions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MySessionEntry" }, "type": "array", "title": "Response My Sessions Api Profile Sessions Get" } } } } } } }, "/api/profile/activity": { "get": { "tags": [ "profile" ], "summary": "My Activity", "operationId": "my_activity_api_profile_activity_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/profile/sessions/{session_id}/disconnect": { "post": { "tags": [ "profile" ], "summary": "Disconnect My Session", "description": "Disconnect one of the caller's own active sessions.", "operationId": "disconnect_my_session_api_profile_sessions__session_id__disconnect_post", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/profile/domain-credentials": { "get": { "tags": [ "profile" ], "summary": "My Domain Credentials", "operationId": "my_domain_credentials_api_profile_domain_credentials_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DomainCredentialOut" }, "type": "array", "title": "Response My Domain Credentials Api Profile Domain Credentials Get" } } } } } }, "put": { "tags": [ "profile" ], "summary": "Set My Domain Credential", "operationId": "set_my_domain_credential_api_profile_domain_credentials_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCredentialIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/profile/domain-credentials/{domain}": { "delete": { "tags": [ "profile" ], "summary": "Delete My Domain Credential", "operationId": "delete_my_domain_credential_api_profile_domain_credentials__domain__delete", "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/settings/session": { "get": { "tags": [ "settings" ], "summary": "Get Session Policy", "operationId": "get_session_policy_api_settings_session_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPolicy" } } } } } }, "put": { "tags": [ "settings" ], "summary": "Update Session Policy", "operationId": "update_session_policy_api_settings_session_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPolicyUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPolicy" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/settings/ldap": { "get": { "tags": [ "settings" ], "summary": "Get Ldap", "operationId": "get_ldap_api_settings_ldap_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapInfo" } } } } } } }, "/api/settings/ldap/test": { "post": { "tags": [ "settings" ], "summary": "Test Ldap", "operationId": "test_ldap_api_settings_ldap_test_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapTestResult" } } } } } } }, "/api/settings/retention": { "get": { "tags": [ "settings" ], "summary": "Get Retention Policy", "operationId": "get_retention_policy_api_settings_retention_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicy" } } } } } }, "put": { "tags": [ "settings" ], "summary": "Update Retention Policy", "operationId": "update_retention_policy_api_settings_retention_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicy" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/settings/purge/resolved-alerts": { "post": { "tags": [ "settings" ], "summary": "Purge Resolved", "operationId": "purge_resolved_api_settings_purge_resolved_alerts_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeResult" } } } } } } }, "/api/settings/purge/recordings": { "post": { "tags": [ "settings" ], "summary": "Purge Old Recordings", "operationId": "purge_old_recordings_api_settings_purge_recordings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeRecordingsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/ai/config": { "get": { "tags": [ "ai" ], "summary": "Get Ai Config", "operationId": "get_ai_config_api_ai_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConfig" } } } } } }, "put": { "tags": [ "ai" ], "summary": "Update Ai Config", "operationId": "update_ai_config_api_ai_config_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConfigUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConfig" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/ai/status": { "get": { "tags": [ "ai" ], "summary": "Ai Status", "operationId": "ai_status_api_ai_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIStatus" } } } } } } }, "/api/ai/chat": { "post": { "tags": [ "ai" ], "summary": "Ai Chat", "operationId": "ai_chat_api_ai_chat_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIChatRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIChatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AIChatRequest": { "properties": { "messages": { "items": { "$ref": "#/components/schemas/AIMessage" }, "type": "array", "title": "Messages" } }, "type": "object", "required": [ "messages" ], "title": "AIChatRequest" }, "AIChatResponse": { "properties": { "reply": { "type": "string", "title": "Reply" } }, "type": "object", "required": [ "reply" ], "title": "AIChatResponse" }, "AIConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "provider": { "type": "string", "title": "Provider", "default": "openai" }, "model": { "type": "string", "title": "Model", "default": "" }, "api_key_set": { "type": "boolean", "title": "Api Key Set", "default": false }, "providers": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Providers" } }, "type": "object", "title": "AIConfig" }, "AIConfigUpdate": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, "type": "object", "title": "AIConfigUpdate" }, "AIMessage": { "properties": { "role": { "type": "string", "title": "Role" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": [ "role", "content" ], "title": "AIMessage" }, "AIStatus": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false } }, "type": "object", "title": "AIStatus" }, "AccessRequestApprove": { "properties": { "duration_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Minutes" }, "target_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Username" }, "target_password": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Target Password" }, "auto_provision_local_user": { "type": "boolean", "title": "Auto Provision Local User", "default": false }, "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" } }, "type": "object", "title": "AccessRequestApprove" }, "AccessRequestCreate": { "properties": { "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "duration_minutes": { "type": "integer", "title": "Duration Minutes", "default": 60 }, "target_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Username" }, "credential_mode": { "type": "string", "title": "Credential Mode", "default": "reuse_console_password" } }, "type": "object", "required": [ "resource_id" ], "title": "AccessRequestCreate" }, "AccessRequestDeny": { "properties": { "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" } }, "type": "object", "title": "AccessRequestDeny" }, "AccessRequestPublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Role" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "resource_host_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Host Kind" }, "resource_protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Protocol" }, "target_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Username" }, "credential_mode": { "type": "string", "title": "Credential Mode", "default": "reuse_console_password" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "duration_minutes": { "type": "integer", "title": "Duration Minutes", "default": 60 }, "status": { "type": "string", "title": "Status", "default": "pending" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "decided_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Decided By" }, "decided_by_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decided By Email" }, "decided_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" } }, "type": "object", "required": [ "id", "user_id", "resource_id", "created_at" ], "title": "AccessRequestPublic" }, "ActiveSessionEntry": { "properties": { "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "resource_hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Hostname" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ago": { "type": "string", "title": "Ago" }, "duration_sec": { "type": "integer", "title": "Duration Sec", "default": 0 } }, "type": "object", "required": [ "session_id", "user_id", "email", "role", "resource_id", "ago" ], "title": "ActiveSessionEntry" }, "ActiveUserEntry": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ago": { "type": "string", "title": "Ago" } }, "type": "object", "required": [ "user_id", "email", "role", "ago" ], "title": "ActiveUserEntry" }, "ActivityDay": { "properties": { "label": { "type": "string", "title": "Label" }, "date": { "type": "string", "title": "Date" }, "hours": { "items": { "type": "integer" }, "type": "array", "title": "Hours" } }, "type": "object", "required": [ "label", "date", "hours" ], "title": "ActivityDay" }, "ActivityHeatmap": { "properties": { "days": { "items": { "$ref": "#/components/schemas/ActivityDay" }, "type": "array", "title": "Days" }, "max": { "type": "integer", "title": "Max", "default": 0 } }, "type": "object", "required": [ "days" ], "title": "ActivityHeatmap", "description": "Connection activity over the last N days, bucketed by day \u00d7 hour.\n\nBuilt from real session start times (SessionORM.started_at)." }, "AlertAction": { "properties": { "minutes": { "type": "integer", "maximum": 10080.0, "minimum": 1.0, "title": "Minutes", "default": 60 } }, "type": "object", "title": "AlertAction" }, "AlertBulkResolve": { "properties": { "ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ids" }, "all_open": { "type": "boolean", "title": "All Open", "default": false } }, "type": "object", "title": "AlertBulkResolve" }, "AlertBulkResult": { "properties": { "resolved": { "type": "integer", "title": "Resolved", "default": 0 }, "counts": { "$ref": "#/components/schemas/AlertCounts" } }, "type": "object", "title": "AlertBulkResult" }, "AlertCounts": { "properties": { "total": { "type": "integer", "title": "Total", "default": 0 }, "active": { "type": "integer", "title": "Active", "default": 0 }, "acknowledged": { "type": "integer", "title": "Acknowledged", "default": 0 }, "resolved": { "type": "integer", "title": "Resolved", "default": 0 } }, "type": "object", "title": "AlertCounts" }, "AlertEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "source": { "type": "string", "title": "Source", "default": "audit" }, "status": { "type": "string", "title": "Status", "default": "new" }, "severity": { "type": "string", "title": "Severity", "default": "info" }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body", "default": "" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "detail": { "additionalProperties": true, "type": "object", "title": "Detail" }, "ts": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ts" }, "acked_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acked By" }, "acked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Acked At" }, "resolved_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved By" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" }, "muted_until": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Muted Until" } }, "type": "object", "required": [ "id", "title" ], "title": "AlertEntry" }, "AlertPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AlertEntry" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "counts": { "$ref": "#/components/schemas/AlertCounts" } }, "type": "object", "required": [ "items", "total", "limit", "offset" ], "title": "AlertPage" }, "AlertRule": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "kind": { "type": "string", "title": "Kind" }, "scope": { "type": "string", "title": "Scope" }, "target_resource_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Target Resource Id" }, "target_resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Resource Name" }, "metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metric" }, "comparator": { "type": "string", "title": "Comparator" }, "threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Threshold" }, "for_minutes": { "type": "integer", "title": "For Minutes" }, "severity": { "type": "string", "title": "Severity" }, "cooldown_minutes": { "type": "integer", "title": "Cooldown Minutes" }, "match_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Action" }, "match_severity": { "type": "string", "title": "Match Severity", "default": "warning" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "enabled", "kind", "scope", "comparator", "for_minutes", "severity", "cooldown_minutes" ], "title": "AlertRule" }, "AlertRuleCreate": { "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "kind": { "type": "string", "title": "Kind", "default": "metric" }, "scope": { "type": "string", "title": "Scope", "default": "all" }, "target_resource_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Target Resource Id" }, "metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metric" }, "comparator": { "type": "string", "title": "Comparator", "default": ">" }, "threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Threshold" }, "for_minutes": { "type": "integer", "maximum": 1440.0, "minimum": 1.0, "title": "For Minutes", "default": 5 }, "severity": { "type": "string", "title": "Severity", "default": "warning" }, "cooldown_minutes": { "type": "integer", "maximum": 1440.0, "minimum": 0.0, "title": "Cooldown Minutes", "default": 30 }, "match_action": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Match Action" }, "match_severity": { "type": "string", "title": "Match Severity", "default": "warning" } }, "type": "object", "required": [ "name" ], "title": "AlertRuleCreate" }, "AlertRuleUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Threshold" }, "comparator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comparator" }, "for_minutes": { "anyOf": [ { "type": "integer", "maximum": 1440.0, "minimum": 1.0 }, { "type": "null" } ], "title": "For Minutes" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "cooldown_minutes": { "anyOf": [ { "type": "integer", "maximum": 1440.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Cooldown Minutes" }, "match_action": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Match Action" }, "match_severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Severity" } }, "type": "object", "title": "AlertRuleUpdate" }, "AuditLogEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "type": "string", "title": "Action" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity", "default": "info" }, "detail": { "additionalProperties": true, "type": "object", "title": "Detail" }, "ts": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ts" } }, "type": "object", "required": [ "id", "action" ], "title": "AuditLogEntry" }, "AuditLogPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditLogEntry" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "actions": { "items": { "type": "string" }, "type": "array", "title": "Actions" } }, "type": "object", "required": [ "items", "total", "limit", "offset" ], "title": "AuditLogPage" }, "Body_sftp_upload_route_api_resources__resource_id__sftp_upload_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_sftp_upload_route_api_resources__resource_id__sftp_upload_post" }, "Body_upload_screenshot_api_audit_screenshot_post": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "x": { "type": "integer", "title": "X", "default": 0 }, "y": { "type": "integer", "title": "Y", "default": 0 }, "button": { "type": "integer", "title": "Button", "default": 0 }, "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "session_id", "file" ], "title": "Body_upload_screenshot_api_audit_screenshot_post" }, "Body_winrm_upload_api_resources__resource_id__winrm_files_upload_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_winrm_upload_api_resources__resource_id__winrm_files_upload_post" }, "DashboardAlert": { "properties": { "id": { "type": "string", "title": "Id" }, "severity": { "type": "string", "title": "Severity" }, "server": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server" }, "body": { "type": "string", "title": "Body" }, "time": { "type": "string", "title": "Time" } }, "type": "object", "required": [ "id", "severity", "body", "time" ], "title": "DashboardAlert" }, "DashboardOverview": { "properties": { "stats": { "items": { "$ref": "#/components/schemas/DashboardStat" }, "type": "array", "title": "Stats" }, "resources": { "items": { "$ref": "#/components/schemas/DashboardResourceTile" }, "type": "array", "title": "Resources" }, "active_users": { "items": { "$ref": "#/components/schemas/ActiveUserEntry" }, "type": "array", "title": "Active Users" }, "alerts": { "items": { "$ref": "#/components/schemas/DashboardAlert" }, "type": "array", "title": "Alerts" }, "healthy": { "type": "boolean", "title": "Healthy", "default": true } }, "type": "object", "required": [ "stats", "resources", "active_users", "alerts" ], "title": "DashboardOverview" }, "DashboardResourceTile": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "hostname": { "type": "string", "title": "Hostname" }, "port": { "type": "integer", "title": "Port" }, "protocol": { "type": "string", "title": "Protocol" }, "online": { "type": "boolean", "title": "Online", "default": true } }, "type": "object", "required": [ "id", "name", "hostname", "port", "protocol" ], "title": "DashboardResourceTile" }, "DashboardStat": { "properties": { "label": { "type": "string", "title": "Label" }, "value": { "type": "string", "title": "Value" }, "sub": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub" } }, "type": "object", "required": [ "label", "value" ], "title": "DashboardStat" }, "DiscoverRequest": { "properties": { "source_resource_id": { "type": "string", "format": "uuid", "title": "Source Resource Id" } }, "type": "object", "required": [ "source_resource_id" ], "title": "DiscoverRequest" }, "DiscoverResponse": { "properties": { "domain": { "type": "string", "title": "Domain" }, "computers": { "items": { "$ref": "#/components/schemas/DiscoveredComputerOut" }, "type": "array", "title": "Computers" } }, "type": "object", "required": [ "domain", "computers" ], "title": "DiscoverResponse" }, "DiscoveredComputerOut": { "properties": { "name": { "type": "string", "title": "Name" }, "dns_hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dns Hostname" }, "os": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Os" }, "enabled": { "type": "boolean", "title": "Enabled" }, "already_added": { "type": "boolean", "title": "Already Added" } }, "type": "object", "required": [ "name", "dns_hostname", "os", "enabled", "already_added" ], "title": "DiscoveredComputerOut" }, "DomainCredentialIn": { "properties": { "domain": { "type": "string", "title": "Domain" }, "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "format": "password", "title": "Password", "writeOnly": true } }, "type": "object", "required": [ "domain", "username", "password" ], "title": "DomainCredentialIn" }, "DomainCredentialOut": { "properties": { "domain": { "type": "string", "title": "Domain" }, "username": { "type": "string", "title": "Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "domain", "username" ], "title": "DomainCredentialOut" }, "GroupCreate": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "GroupCreate" }, "GroupPublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "server_count": { "type": "integer", "title": "Server Count", "default": 0 } }, "type": "object", "required": [ "id", "name" ], "title": "GroupPublic" }, "GroupUpdate": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "GroupUpdate" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImportComputer": { "properties": { "name": { "type": "string", "title": "Name" }, "dns_hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dns Hostname" } }, "type": "object", "required": [ "name" ], "title": "ImportComputer" }, "ImportRequest": { "properties": { "source_resource_id": { "type": "string", "format": "uuid", "title": "Source Resource Id" }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id" }, "protocol": { "type": "string", "title": "Protocol", "default": "rdp" }, "computers": { "items": { "$ref": "#/components/schemas/ImportComputer" }, "type": "array", "title": "Computers" } }, "type": "object", "required": [ "source_resource_id", "computers" ], "title": "ImportRequest" }, "LdapInfo": { "properties": { "url": { "type": "string", "title": "Url" }, "base_dn": { "type": "string", "title": "Base Dn" } }, "type": "object", "required": [ "url", "base_dn" ], "title": "LdapInfo" }, "LdapTestResult": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "reachable": { "type": "boolean", "title": "Reachable", "default": false }, "message": { "type": "string", "title": "Message", "default": "" } }, "type": "object", "required": [ "ok" ], "title": "LdapTestResult" }, "LoginRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "format": "password", "title": "Password", "writeOnly": true } }, "type": "object", "required": [ "email", "password" ], "title": "LoginRequest" }, "LoginResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "token_type": { "type": "string", "title": "Token Type", "default": "bearer" }, "user": { "$ref": "#/components/schemas/UserPublic" }, "idle_minutes": { "type": "integer", "title": "Idle Minutes", "default": 30 }, "recovery_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Recovery Codes" } }, "type": "object", "required": [ "access_token", "user" ], "title": "LoginResponse" }, "MetricSample": { "properties": { "target": { "type": "string", "title": "Target" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "protocol": { "type": "string", "title": "Protocol", "default": "host" }, "ts": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ts" }, "available": { "type": "boolean", "title": "Available", "default": false }, "cpu_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpu Pct" }, "ram_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ram Pct" }, "disk_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Disk Pct" }, "uptime_sec": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Uptime Sec" } }, "type": "object", "required": [ "target" ], "title": "MetricSample" }, "MySessionEntry": { "properties": { "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "resource_hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Hostname" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "status": { "type": "string", "title": "Status" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ago": { "type": "string", "title": "Ago", "default": "" }, "duration_sec": { "type": "integer", "title": "Duration Sec", "default": 0 } }, "type": "object", "required": [ "session_id", "resource_id", "status" ], "title": "MySessionEntry" }, "NotificationConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "webhook_enabled": { "type": "boolean", "title": "Webhook Enabled", "default": false }, "webhook_url": { "type": "string", "title": "Webhook Url", "default": "" }, "email_enabled": { "type": "boolean", "title": "Email Enabled", "default": false }, "email_to": { "type": "string", "title": "Email To", "default": "" }, "email_from": { "type": "string", "title": "Email From", "default": "" }, "telegram_enabled": { "type": "boolean", "title": "Telegram Enabled", "default": false }, "telegram_chat_id": { "type": "string", "title": "Telegram Chat Id", "default": "" }, "telegram_token_set": { "type": "boolean", "title": "Telegram Token Set", "default": false } }, "type": "object", "title": "NotificationConfig" }, "NotificationTestResult": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "webhook": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Webhook" }, "email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Email" }, "telegram": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Telegram" } }, "type": "object", "title": "NotificationTestResult" }, "NotificationUpdate": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "webhook_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Webhook Enabled" }, "webhook_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhook Url" }, "email_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Email Enabled" }, "email_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email To" }, "telegram_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Telegram Enabled" }, "telegram_chat_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telegram Chat Id" }, "telegram_bot_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telegram Bot Token" } }, "type": "object", "title": "NotificationUpdate" }, "PasswordChangeRequest": { "properties": { "current_password": { "type": "string", "format": "password", "title": "Current Password", "writeOnly": true }, "new_password": { "type": "string", "maxLength": 256, "minLength": 8, "format": "password", "title": "New Password", "writeOnly": true } }, "type": "object", "required": [ "current_password", "new_password" ], "title": "PasswordChangeRequest" }, "PermissionCreate": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "ad_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Login" }, "target_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Username" }, "target_password": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Target Password" }, "credential_mode": { "type": "string", "title": "Credential Mode", "default": "reuse_console_password" }, "auto_provision_local_user": { "type": "boolean", "title": "Auto Provision Local User", "default": false }, "can_write": { "type": "boolean", "title": "Can Write", "default": true } }, "type": "object", "required": [ "user_id", "resource_id" ], "title": "PermissionCreate" }, "PermissionPublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "ad_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Login" }, "target_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Username" }, "credential_mode": { "type": "string", "title": "Credential Mode", "default": "reuse_console_password" }, "auto_provision_local_user": { "type": "boolean", "title": "Auto Provision Local User", "default": false }, "can_write": { "type": "boolean", "title": "Can Write", "default": true } }, "type": "object", "required": [ "id", "user_id", "resource_id" ], "title": "PermissionPublic" }, "PermissionRevokeResult": { "properties": { "revoked": { "type": "boolean", "title": "Revoked", "default": true }, "deprovision_attempted": { "type": "boolean", "title": "Deprovision Attempted", "default": false }, "deprovision_ok": { "type": "boolean", "title": "Deprovision Ok", "default": false }, "deprovision_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deprovision Message" } }, "type": "object", "title": "PermissionRevokeResult", "description": "Outcome of revoking a permission, incl. best-effort host deprovision." }, "ProfileSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "ad_upn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Upn" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "last_login": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Login" }, "totp_enabled": { "type": "boolean", "title": "Totp Enabled", "default": false } }, "type": "object", "required": [ "id", "email", "role" ], "title": "ProfileSummary" }, "PurgeRecordingsRequest": { "properties": { "older_than_days": { "type": "integer", "maximum": 3650.0, "minimum": 1.0, "title": "Older Than Days", "default": 90 } }, "type": "object", "title": "PurgeRecordingsRequest" }, "PurgeResult": { "properties": { "deleted": { "type": "integer", "title": "Deleted", "default": 0 } }, "type": "object", "title": "PurgeResult" }, "RecordingEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "title": "Session Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "size_bytes": { "type": "integer", "title": "Size Bytes", "default": 0 }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ended At" }, "duration_sec": { "type": "integer", "title": "Duration Sec", "default": 0 }, "kind": { "type": "string", "title": "Kind", "default": "guac" }, "truncated": { "type": "boolean", "title": "Truncated", "default": false }, "download_url": { "type": "string", "title": "Download Url" } }, "type": "object", "required": [ "id", "session_id", "download_url" ], "title": "RecordingEntry" }, "RecordingPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RecordingEntry" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "items", "total", "limit", "offset" ], "title": "RecordingPage" }, "RefreshResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "idle_minutes": { "type": "integer", "title": "Idle Minutes", "default": 30 } }, "type": "object", "required": [ "access_token" ], "title": "RefreshResponse" }, "ResourceCatalogItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "protocol": { "type": "string", "title": "Protocol" }, "host_kind": { "type": "string", "title": "Host Kind", "default": "ad_member" } }, "type": "object", "required": [ "id", "name", "protocol" ], "title": "ResourceCatalogItem", "description": "Minimal, secret-free resource view for the JIT request catalog." }, "ResourceCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "hostname": { "type": "string", "title": "Hostname" }, "port": { "type": "integer", "title": "Port", "default": 3389 }, "protocol": { "type": "string", "title": "Protocol", "default": "rdp" }, "host_kind": { "type": "string", "title": "Host Kind", "default": "ad_member" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "service_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Username" }, "service_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Domain" }, "service_password": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Service Password" }, "service_private_key": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Service Private Key" }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id" } }, "type": "object", "required": [ "name", "hostname" ], "title": "ResourceCreate" }, "ResourceMetrics": { "properties": { "available": { "type": "boolean", "title": "Available", "default": false }, "cpu_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpu Pct" }, "ram_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ram Pct" }, "disk_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Disk Pct" }, "uptime_sec": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Uptime Sec" }, "net_rx_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Rx Bytes" }, "net_tx_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Tx Bytes" } }, "type": "object", "title": "ResourceMetrics" }, "ResourcePublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "hostname": { "type": "string", "title": "Hostname" }, "port": { "type": "integer", "title": "Port" }, "protocol": { "type": "string", "title": "Protocol" }, "host_kind": { "type": "string", "title": "Host Kind", "default": "ad_member" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "service_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Username" }, "service_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Domain" }, "has_service_account": { "type": "boolean", "title": "Has Service Account", "default": false }, "has_service_key": { "type": "boolean", "title": "Has Service Key", "default": false }, "has_host_key": { "type": "boolean", "title": "Has Host Key", "default": false }, "host_key_fingerprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host Key Fingerprint" }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id" }, "can_connect": { "type": "boolean", "title": "Can Connect", "default": true } }, "type": "object", "required": [ "id", "name", "hostname", "port", "protocol" ], "title": "ResourcePublic" }, "ResourceReadinessCheck": { "properties": { "key": { "type": "string", "title": "Key" }, "ok": { "type": "boolean", "title": "Ok" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "key", "ok", "message" ], "title": "ResourceReadinessCheck" }, "ResourceReadinessResult": { "properties": { "ready": { "type": "boolean", "title": "Ready" }, "checks": { "items": { "$ref": "#/components/schemas/ResourceReadinessCheck" }, "type": "array", "title": "Checks" }, "summary": { "type": "string", "title": "Summary", "default": "" } }, "type": "object", "required": [ "ready" ], "title": "ResourceReadinessResult" }, "ResourceTestResult": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "latency_ms": { "type": "integer", "title": "Latency Ms" }, "protocol": { "type": "string", "title": "Protocol" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "ok", "latency_ms", "protocol", "message" ], "title": "ResourceTestResult" }, "ResourceUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname" }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Port" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "host_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host Kind" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "service_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Username" }, "service_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Domain" }, "service_password": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Service Password" }, "service_private_key": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Service Private Key" }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id" } }, "type": "object", "title": "ResourceUpdate" }, "RetentionPolicy": { "properties": { "recordings_days": { "type": "integer", "title": "Recordings Days", "default": 0 } }, "type": "object", "title": "RetentionPolicy" }, "RetentionUpdate": { "properties": { "recordings_days": { "anyOf": [ { "type": "integer", "maximum": 3650.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Recordings Days" } }, "type": "object", "title": "RetentionUpdate" }, "ScreenshotEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "title": "Session Id" }, "x": { "type": "integer", "title": "X", "default": 0 }, "y": { "type": "integer", "title": "Y", "default": 0 }, "button": { "type": "integer", "title": "Button", "default": 0 }, "ts": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ts" }, "url": { "type": "string", "title": "Url" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Name" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" } }, "type": "object", "required": [ "id", "session_id", "url" ], "title": "ScreenshotEntry" }, "SessionCreateRequest": { "properties": { "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" } }, "type": "object", "required": [ "resource_id" ], "title": "SessionCreateRequest" }, "SessionPolicy": { "properties": { "idle_minutes": { "type": "integer", "title": "Idle Minutes", "default": 30 }, "idle_minutes_elevated": { "type": "integer", "title": "Idle Minutes Elevated", "default": 30 }, "allow_clipboard": { "type": "boolean", "title": "Allow Clipboard", "default": true }, "allow_file_transfer": { "type": "boolean", "title": "Allow File Transfer", "default": true }, "max_session_minutes": { "type": "integer", "title": "Max Session Minutes", "default": 0 }, "two_factor_required": { "type": "boolean", "title": "Two Factor Required", "default": true } }, "type": "object", "title": "SessionPolicy" }, "SessionPolicyUpdate": { "properties": { "idle_minutes": { "anyOf": [ { "type": "integer", "maximum": 1440.0, "minimum": 5.0 }, { "type": "null" } ], "title": "Idle Minutes" }, "idle_minutes_elevated": { "anyOf": [ { "type": "integer", "maximum": 1440.0, "minimum": 5.0 }, { "type": "null" } ], "title": "Idle Minutes Elevated" }, "allow_clipboard": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Clipboard" }, "allow_file_transfer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow File Transfer" }, "max_session_minutes": { "anyOf": [ { "type": "integer", "maximum": 1440.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Max Session Minutes" }, "two_factor_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Two Factor Required" } }, "type": "object", "title": "SessionPolicyUpdate" }, "SessionPublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "resource_id": { "type": "string", "format": "uuid", "title": "Resource Id" }, "status": { "type": "string", "title": "Status" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "connection_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Token" }, "ws_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ws Url" } }, "type": "object", "required": [ "id", "resource_id", "status" ], "title": "SessionPublic" }, "SftpFileEntry": { "properties": { "name": { "type": "string", "title": "Name" }, "size": { "type": "integer", "title": "Size" }, "is_dir": { "type": "boolean", "title": "Is Dir" }, "mtime": { "type": "integer", "title": "Mtime" } }, "type": "object", "required": [ "name", "size", "is_dir", "mtime" ], "title": "SftpFileEntry" }, "SftpTransferRequest": { "properties": { "src_resource_id": { "type": "string", "format": "uuid", "title": "Src Resource Id" }, "dst_resource_id": { "type": "string", "format": "uuid", "title": "Dst Resource Id" }, "src_path": { "type": "string", "title": "Src Path" }, "dst_path": { "type": "string", "title": "Dst Path" } }, "type": "object", "required": [ "src_resource_id", "dst_resource_id", "src_path", "dst_path" ], "title": "SftpTransferRequest" }, "TwoFactorVerifyRequest": { "properties": { "code": { "type": "string", "title": "Code" } }, "type": "object", "required": [ "code" ], "title": "TwoFactorVerifyRequest" }, "UserCreate": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "auth_provider": { "type": "string", "title": "Auth Provider", "default": "ldap" }, "ad_upn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Upn" }, "password": { "anyOf": [ { "type": "string", "format": "password", "writeOnly": true }, { "type": "null" } ], "title": "Password" }, "role": { "type": "string", "title": "Role", "default": "user" } }, "type": "object", "required": [ "email" ], "title": "UserCreate" }, "UserPublic": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "ad_upn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Upn" }, "auth_provider": { "type": "string", "title": "Auth Provider", "default": "ldap" }, "must_change_password": { "type": "boolean", "title": "Must Change Password", "default": false }, "disabled": { "type": "boolean", "title": "Disabled", "default": false } }, "type": "object", "required": [ "id", "email", "role" ], "title": "UserPublic" }, "UserUpdate": { "properties": { "ad_upn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Upn" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled" } }, "type": "object", "title": "UserUpdate" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } } }