{ "openapi": "3.0.4", "info": { "title": "immy.bot API", "version": "v1" }, "paths": { "/api/v1/application-locks": { "get": { "tags": [ "ApplicationLocks" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationLocksResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationLocksResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationLocksResponse" } } } } } } } }, "/api/v1/application-locks/realtime-event-stream": { "get": { "tags": [ "ApplicationLocks" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationLockEventEventStream" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationLockEventEventStream" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationLockEventEventStream" } } } } } } }, "/api/v1/application-locks/request-cancellation": { "post": { "tags": [ "ApplicationLocks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CancelApplicationLockRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CancelApplicationLockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelApplicationLockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelApplicationLockRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/api/v1/application-logs/source-context": { "post": { "tags": [ "ApplicationLogs" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateApplicationLogSourceContextRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApplicationLogSourceContextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateApplicationLogSourceContextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateApplicationLogSourceContextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/application-logs/source-context/clear": { "post": { "tags": [ "ApplicationLogs" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ClearApplicationLogSourceContextRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClearApplicationLogSourceContextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClearApplicationLogSourceContextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClearApplicationLogSourceContextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/application-logs/source-context/clear-all": { "post": { "tags": [ "ApplicationLogs" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/application-logs/streaming": { "post": { "tags": [ "ApplicationLogs" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ToggleApplicationLogStreamingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ToggleApplicationLogStreamingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ToggleApplicationLogStreamingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ToggleApplicationLogStreamingRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/application-logs/source-contexts": { "get": { "tags": [ "ApplicationLogs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSourceContextsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSourceContextsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSourceContextsResponse" } } } } } } }, "/api/v1/audits/local/dx": { "get": { "tags": [ "Audits" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } } } } } } }, "/api/v1/audits/global/dx": { "get": { "tags": [ "Audits" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } } } } } } }, "/api/v1/auth": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetAuthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetAuthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetAuthResponse" } } } } } } }, "/api/v1/auth/update-azure-tenant-auth-details": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantAuthDetailsCmdResult" } } } } } } }, "/api/v1/auth/delete-azure-tenant-auth-details": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAzureTenantAuthDetailsCmdResult" } } } } } } }, "/api/v1/auth/get-azure-tenant-auth-details/{azureTenantPrincipalId}": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "azureTenantPrincipalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AzureTenantAuthDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AzureTenantAuthDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AzureTenantAuthDetails" } } } } } } }, "/api/v1/auth/get-ip-addresses": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImmyIpAndHostnamesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImmyIpAndHostnamesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImmyIpAndHostnamesResponse" } } } } } } }, "/api/v1/auth/request-access": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } } } } } } }, "/api/v1/auth/me/permissions/{permissionType}/tenants": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "permissionType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleTenantDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleTenantDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleTenantDetails" } } } } } } } }, "/api/v1/me/permissions": { "get": { "tags": [ "Auth" ], "summary": "Gets all role assignments and groups for the current user", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyPermissionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyPermissionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyPermissionsResponse" } } } } } } }, "/api/v1/azure/partner-tenant-customers/{partnerPrincipalId}": { "get": { "tags": [ "Azure" ], "parameters": [ { "name": "partnerPrincipalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantCustomersResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantCustomersResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantCustomersResult" } } } } } } } }, "/api/v1/azure/partner-tenant-infos": { "get": { "tags": [ "Azure" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantInfoResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantInfoResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantInfoResult" } } } } } } } }, "/api/v1/azure/sync-users-from-azure-tenants": { "post": { "tags": [ "Azure" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantUserSyncResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantUserSyncResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantUserSyncResult" } } } } } } } }, "/api/v1/azure/preconsent-customer-tenants": { "post": { "tags": [ "Azure" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PreconsentCustomerTenantsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreconsentCustomerTenantsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreconsentCustomerTenantsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreconsentCustomerTenantsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/azure/sync-details-from-azure-tenants": { "post": { "tags": [ "Azure" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncAzureDataForTenantsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantDetailsSyncResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantDetailsSyncResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantDetailsSyncResult" } } } } } } } }, "/api/v1/azure/tenant-consented": { "post": { "tags": [ "Azure" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TenantConsentRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantConsentRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantConsentRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantConsentRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantConsentResponseBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantConsentResponseBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantConsentResponseBody" } } } } } } }, "/api/v1/azure/disambiguate-azure-tenant-type": { "post": { "tags": [ "Azure" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DisambiguateAzureTenantTypeRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DisambiguateAzureTenantTypeRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisambiguateAzureTenantTypeRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DisambiguateAzureTenantTypeRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CheckTenantPartnerStatusResponseBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckTenantPartnerStatusResponseBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckTenantPartnerStatusResponseBody" } } } } } } }, "/api/v1/azure/app-registration-options": { "get": { "tags": [ "Azure" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppRegistrationOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppRegistrationOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppRegistrationOption" } } } } } } } }, "/api/v1/azure-errors/for-tenant/{tenantPrincipalId}/dx": { "get": { "tags": [ "AzureErrors" ], "parameters": [ { "name": "tenantPrincipalId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } } } } } } }, "/api/v1/azure-errors/dx": { "get": { "tags": [ "AzureErrors" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureErrorLogItem" } } } } } } } }, "/api/v1/billing/create-customer-portal-session": { "post": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCustomerPortalSessionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerPortalSessionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCustomerPortalSessionResult" } } } } } } }, "/api/v1/billing/subscription-details": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSubscriptionDetailsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionDetailsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionDetailsResponse" } } } } } } }, "/api/v1/billing/product-catalog-items": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProductCatalogItemsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProductCatalogItemsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProductCatalogItemsResponse" } } } } } } }, "/api/v1/billing/billing-platform-details": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingPlatformDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlatformDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingPlatformDetails" } } } } } } }, "/api/v1/brandings": { "get": { "tags": [ "Brandings" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetBrandingResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetBrandingResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetBrandingResponse" } } } } } } }, "post": { "tags": [ "Brandings" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateBrandingRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateBrandingRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBrandingRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBrandingRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } } } } } } }, "/api/v1/brandings/{id}": { "get": { "tags": [ "Brandings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } } } } } }, "put": { "tags": [ "Brandings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBrandingRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandingRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandingRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBrandingRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBrandingResponse" } } } } } }, "delete": { "tags": [ "Brandings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/brandings/global-default/{id}": { "post": { "tags": [ "Brandings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/brandings/send-test-email": { "post": { "tags": [ "Brandings" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendTestBrandingEmailRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendTestBrandingEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendTestBrandingEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendTestBrandingEmailRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/brandings/validate-time-format/{timeFormat}": { "post": { "tags": [ "Brandings" ], "parameters": [ { "name": "timeFormat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/brandings/support-branding": { "get": { "tags": [ "Brandings" ], "summary": "Fetches support related branding changes to be used in the Support Sidebar, Session Support Request, or other Support related UI.\r\nThese branding changes can be specified by Dynamic Providers implementing 'ISupportsSupportTicketDetailOverride'", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSupportBrandingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSupportBrandingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSupportBrandingResponse" } } } } } } }, "/api/v1/change-requests/{id}": { "delete": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/change-requests/{id}/approve": { "post": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/change-requests/{id}/deny": { "post": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/change-requests/{id}/require-changes": { "post": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/change-requests/{id}/comment": { "post": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddChangeRequestCommentBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddChangeRequestCommentBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddChangeRequestCommentBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddChangeRequestCommentBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestCommentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestCommentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestCommentResponse" } } } } } } }, "/api/v1/change-requests/dx": { "get": { "tags": [ "ChangeRequests" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/change-requests/open-count": { "get": { "tags": [ "ChangeRequests" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/chocolatey/search": { "get": { "tags": [ "Chocolatey" ], "parameters": [ { "name": "searchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoSearchResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoSearchResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoSearchResult" } } } } } } } }, "/api/v1/chocolatey/find-packages-by-id": { "get": { "tags": [ "Chocolatey" ], "parameters": [ { "name": "packageId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoPackageVersion" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoPackageVersion" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChocoPackageVersion" } } } } } } } }, "/api/v1/computers/agent-status": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerAgentStatusDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerAgentStatusDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerAgentStatusDto" } } } } } } } }, "/api/v1/computers/inventory": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxComputerInventoryScriptResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxComputerInventoryScriptResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxComputerInventoryScriptResult" } } } } } } } }, "/api/v1/computers/inventory/export": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/detected-computer-software": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } } } } } } }, "/api/v1/computers/{computerId}/ephemeral-agent": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetEphemeralAgentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetEphemeralAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetEphemeralAgentResponse" } } } } } }, "delete": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/ephemeral-agent-circuit-breaker": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } } } } } } }, "/api/v1/computers/{computerId}/ephemeral-agent-circuit-breaker/reset": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResultCircuitBreakerState" } } } } } } }, "/api/v1/computers/restore": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/computers": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderByUpdatedDate", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerSearch" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerSearch" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerSearch" } } } } } } } }, "/api/v1/computers/paged": { "get": { "tags": [ "Computers" ], "summary": "TODO: Move this to V2 api routes or make the existing GetAll rely on this", "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "sortDesc", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "onboardingOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "staleOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "devLabOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeOffline", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "licensedOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "deletedOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ComputerPageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ComputerPageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerPageResponse" } } } } } } }, "/api/v1/computers/dx": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/computers/{computerId}/exclude-from-user-affinity": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetExcludedFromUserAffinityRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetExcludedFromUserAffinityRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetExcludedFromUserAffinityRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetExcludedFromUserAffinityRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/set-excluded-from-user-affinity": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BatchSetExcludedFromUserAffinityRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchSetExcludedFromUserAffinityRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchSetExcludedFromUserAffinityRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchSetExcludedFromUserAffinityRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSessions", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAdditionalPersons", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includePrimaryPerson", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includeProviderAgents", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeProviderAgentsDeviceUpdateFormData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } } } } } }, "put": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetComputerResponse" } } } } } } }, "/api/v1/computers/user-affinities/export": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/user-affinities": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "computerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerUserAffinityResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerUserAffinityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerUserAffinityResponse" } } } } } } } }, "/api/v1/computers/{computerId}/inventory-script-results/{inventoryKey}": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "inventoryKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/device-update-form-data": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetComputerDeviceUpdateFormDataResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetComputerDeviceUpdateFormDataResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetComputerDeviceUpdateFormDataResponse" } } } } } } }, "/api/v1/computers/onboarding": { "get": { "tags": [ "Computers" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOnboardingComputerResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOnboardingComputerResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOnboardingComputerResponse" } } } } } } } }, "/api/v1/computers/{computerId}/status": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/computers/{computerId}/update-primary-person": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerPrimaryPersonRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerPrimaryPersonRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerPrimaryPersonRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerPrimaryPersonRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPersonResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPersonResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPersonResponse" } } } } } } }, "/api/v1/computers/{computerId}/update-additional-persons": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerAdditionalPersonsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerAdditionalPersonsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateComputerAdditionalPersonsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateComputerAdditionalPersonsRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/set-to-needs-onboarding": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/change-tenant": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeTenantsPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTenantsPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeTenantsPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeTenantsPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } } } } } } }, "/api/v1/computers/skip-onboarding": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkipOnboardingResponse" } } } } } } } }, "/api/v1/computers/{computerId}/provider-links/{providerLinkId}/screen-share-url": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "providerLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } } } } } } }, "/api/v1/computers/{computerId}/reinventory": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryDeviceCmdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryDeviceCmdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryDeviceCmdResponse" } } } } } } }, "/api/v1/computers/{computerId}/resolve-onboarding-overridable-target-assignments": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResolveOnboardingOverridableAssignmentsResponseBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveOnboardingOverridableAssignmentsResponseBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveOnboardingOverridableAssignmentsResponseBody" } } } } } } }, "/api/v1/computers/bulk-delete": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } } } } } } }, "/api/v1/computers/my": { "get": { "tags": [ "Computers" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyComputerResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyComputerResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyComputerResponse" } } } } } } } }, "/api/v1/computers/inventory-software/search-by-upgrade-code": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } } } } } } }, "/api/v1/computers/inventory-software/search-by-name": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "searchMode", "in": "query", "description": "The string or integer value may be used. Contains = 0, Regex = 1, Traditional = 2", "schema": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventorySoftware" } } } } } } } }, "/api/v1/computers/{computerId}/events": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineEvent" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineEvent" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineEvent" } } } } } } } }, "/api/v1/computers/add-tags": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/remove-tags": { "post": { "tags": [ "Computers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/exclude-from-maintenance": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExcludeFromMaintenanceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExcludeFromMaintenanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExcludeFromMaintenanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExcludeFromMaintenanceRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/export": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/computers/{computerId}/launch-ephemeral-agent": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/api/v1/computers/{computerId}/registry/keys": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegistryKeyDtoArrayOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistryKeyDtoArrayOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryKeyDtoArrayOpResult" } } } } } } }, "/api/v1/computers/{computerId}/registry/values": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistryPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegistryValueDtoArrayOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistryValueDtoArrayOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryValueDtoArrayOpResult" } } } } } } }, "/api/v1/computers/{computerId}/parent-tenant-info": { "get": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ParentTenantInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ParentTenantInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParentTenantInfo" } } } } } } }, "/api/v1/computers/{computerId}/notes": { "post": { "tags": [ "Computers" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/test-environment/{terminalId}": { "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "terminalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetupTestIntegrationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetupTestIntegrationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetupTestIntegrationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetupTestIntegrationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } } } } } }, "delete": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "terminalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/test-environment/{terminalId}/execute-method/{method}": { "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "terminalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "method", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TestIntegrationMethodRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestIntegrationMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestIntegrationMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestIntegrationMethodRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ObjectOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ObjectOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectOpResult" } } } } } } }, "/api/v1/dynamic-provider-types/test-environment/{terminalId}/bind-configuration-form": { "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "terminalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TestIntegrationBindConfigurationFormRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestIntegrationBindConfigurationFormRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestIntegrationBindConfigurationFormRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestIntegrationBindConfigurationFormRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultOpResult" } } } } } } }, "/api/v1/dynamic-provider-types/reload": { "post": { "tags": [ "DynamicIntegrationTypes" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/global/{id}/reload": { "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/local/{id}/reload": { "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types": { "get": { "tags": [ "DynamicIntegrationTypes" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } } } }, "/api/v1/dynamic-provider-types/global/{id}": { "get": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } }, "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } }, "delete": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/local/{id}": { "get": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } }, "post": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicIntegrationTypePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } }, "delete": { "tags": [ "DynamicIntegrationTypes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dynamic-provider-types/global": { "post": { "tags": [ "DynamicIntegrationTypes" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } } }, "/api/v1/dynamic-provider-types/local;": { "post": { "tags": [ "DynamicIntegrationTypes" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDynamicIntegrationTypePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicIntegrationTypeResponse" } } } } } } }, "/api/v1/effective-permissions/users/{userId}/evaluate/all-assignments": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Returns all role assignments for a user grouped by permission without evaluation context.\r\nShows assignment overview without determining effective allow/deny.", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying optional permission filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } } } } } } }, "/api/v1/effective-permissions/groups/{groupId}/evaluate/all-assignments": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Returns all role assignments for a group grouped by permission without evaluation context.\r\nShows assignment overview without determining effective allow/deny.", "parameters": [ { "name": "groupId", "in": "path", "description": "The group ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying optional permission filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateAllAssignmentsResponse" } } } } } } }, "/api/v1/effective-permissions/users/{userId}/evaluate/tenant": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Evaluates permissions for a user against a specific tenant.\r\nDetermines effective allow/deny for each permission within that tenant context.", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying tenant context.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } } } } } } }, "/api/v1/effective-permissions/groups/{groupId}/evaluate/tenant": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Evaluates permissions for a group against a specific tenant.\r\nDetermines effective allow/deny for each permission within that tenant context.", "parameters": [ { "name": "groupId", "in": "path", "description": "The group ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying tenant context.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateTenantPermissionsResponse" } } } } } } }, "/api/v1/effective-permissions/users/{userId}/evaluate/resource": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Evaluates permissions for a user against a specific resource.\r\nDetermines effective allow/deny for each permission within that resource context.", "parameters": [ { "name": "userId", "in": "path", "description": "The user ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying resource context.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } } } } } } }, "/api/v1/effective-permissions/groups/{groupId}/evaluate/resource": { "post": { "tags": [ "EffectivePermissions" ], "summary": "Evaluates permissions for a group against a specific resource.\r\nDetermines effective allow/deny for each permission within that resource context.", "parameters": [ { "name": "groupId", "in": "path", "description": "The group ID to evaluate permissions for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request specifying resource context.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateResourcePermissionsResponse" } } } } } } }, "/api/v1/maintenance-emails/{emailGuid}/jobs/postpone": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "emailGuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/maintenance-emails/{emailGuid}/jobs/rebootnow": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "emailGuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/maintenance-emails/{emailGuid}/jobs/now": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "emailGuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/ephemeral-session/development/latest-ephemeral-binary": { "get": { "tags": [ "EphemeralAgent" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "EphemeralAgent" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ephemeral-session/{ephemeralSessionId}/{agentInstanceId}/{providerAgentId}": { "get": { "tags": [ "EphemeralAgent" ], "parameters": [ { "name": "ephemeralSessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "agentInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "providerAgentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/getting-started/checklist": { "get": { "tags": [ "GettingStarted" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GettingStartedChecklist" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GettingStartedChecklist" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GettingStartedChecklist" } } } } } } }, "/api/v1/getting-started/checklist/reset": { "post": { "tags": [ "GettingStarted" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/getting-started/checklist/complete": { "post": { "tags": [ "GettingStarted" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/groups": { "get": { "tags": [ "Groups" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } } } } } } }, "post": { "tags": [ "Groups" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } } } } }, "/api/v1/groups/{groupId}": { "get": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } } } }, "put": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } } } }, "delete": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/groups/{groupId}/role-assignments": { "get": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "RequireTotalCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "RequireGroupCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsCountQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsSummaryQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SortingInfo" } } }, { "name": "Group", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupingInfo" } } }, { "name": "Filter", "in": "query", "schema": { "type": "array", "items": { } } }, { "name": "TotalSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "GroupSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "Select", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PreSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RemoteSelect", "in": "query", "schema": { "type": "boolean" } }, { "name": "RemoteGrouping", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExpandLinqSumType", "in": "query", "schema": { "type": "boolean" } }, { "name": "PrimaryKey", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultSort", "in": "query", "schema": { "type": "string" } }, { "name": "StringToLower", "in": "query", "schema": { "type": "boolean" } }, { "name": "PaginateViaPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "SortByPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "AllowAsyncOverSync", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } } } } } } }, "/api/v1/groups/{groupId}/members": { "post": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddUserToGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUserToGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUserToGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddUserToGroupRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } } } } } } }, "/api/v1/groups/{groupId}/members/bulk": { "post": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddUsersToGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUsersToGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUsersToGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddUsersToGroupRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/groups/{groupId}/members/{userId}": { "delete": { "tags": [ "Groups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/immy-agent-metadata/agent-hash": { "get": { "tags": [ "ImmyAgentMetadata" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetAgentSha256HashResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetAgentSha256HashResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetAgentSha256HashResponse" } } } } } } }, "/api/v1/run-immy-service": { "post": { "tags": [ "Immybot" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RunImmyServiceResponseBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceResponseBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceResponseBody" } } } } } } }, "/api/v1/run-immy-service-new": { "post": { "tags": [ "Immybot" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunImmyServiceRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/inventory-tasks": { "get": { "tags": [ "InventoryTasks" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTaskResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTaskResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTaskResource" } } } } } } } }, "/api/v1/inventory-tasks/local": { "post": { "tags": [ "InventoryTasks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } } } } } } }, "/api/v1/inventory-tasks/local/{id}": { "post": { "tags": [ "InventoryTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } } } } } }, "delete": { "tags": [ "InventoryTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } } } } } } }, "/api/v1/inventory-tasks/local/{id}/scripts": { "post": { "tags": [ "InventoryTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskScriptResource" } } } } } } }, "/api/v1/inventory-tasks/local/{taskId}/scripts/{inventoryKey}": { "delete": { "tags": [ "InventoryTasks" ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "inventoryKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTaskResource" } } } } } } }, "/api/v1/licenses/dx": { "get": { "tags": [ "Licenses" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/licenses": { "get": { "tags": [ "Licenses" ], "parameters": [ { "name": "filters", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLicenseResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLicenseResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLicenseResponse" } } } } } } }, "post": { "tags": [ "Licenses" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLicenseRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLicenseRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLicenseRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLicenseRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } } } } } } }, "/api/v1/licenses/{licenseId}": { "get": { "tags": [ "Licenses" ], "parameters": [ { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } } } } } }, "put": { "tags": [ "Licenses" ], "parameters": [ { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLicenseRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLicenseRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLicenseRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLicenseRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } } } } } }, "delete": { "tags": [ "Licenses" ], "parameters": [ { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/licenses/upload": { "post": { "tags": [ "Licenses" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/licenses/{licenseId}/request-download": { "get": { "tags": [ "Licenses" ], "parameters": [ { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/maintenance-actions/dx": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } } } } } } }, "/api/v1/maintenance-actions/latest-non-compliant-actions-for-tenant/{tenantId}": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } } } }, "/api/v1/maintenance-actions/latest-action-for-computers": { "post": { "tags": [ "MaintenanceActions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForComputersRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForComputersRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForComputersRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForComputersRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } } } } } } }, "/api/v1/maintenance-actions/latest-action-for-tenants": { "post": { "tags": [ "MaintenanceActions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForTenantsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForTenantsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForTenantsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetLatestActionForTenantsRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } } } }, "/api/v1/maintenance-actions/latest-for-computer/{computerId}": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestActionForComputer" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestActionForComputer" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestActionForComputer" } } } } } } } }, "/api/v1/maintenance-actions/latest-for-tenant/{tenantId}": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "createdDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sessionType", "in": "query", "description": "The string or integer value may be used. Cloud = 1, Computer = 2, Person = 3", "schema": { "$ref": "#/components/schemas/SessionType" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } } } }, "/api/v1/maintenance-actions/dx-for-computer/{computerId}": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/maintenance-actions/maintenance-item": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "maintenanceType", "in": "query", "description": "The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7", "schema": { "$ref": "#/components/schemas/MaintenanceType" } }, { "name": "maintenanceIdentifier", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } } } } } } }, "/api/v1/maintenance-actions/version": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "softwareType", "in": "query", "description": "The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4", "schema": { "$ref": "#/components/schemas/SoftwareType" } }, { "name": "softwareIdentifier", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } } } } } } }, "/api/v1/maintenance-actions/{actionId}/logs": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } } } } } } }, "/api/v1/maintenance-actions/computer/{computerId}/needs-attention": { "get": { "tags": [ "MaintenanceActions" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } } } } } } } }, "/api/v1/maintenance-sessions/dx": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "computerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "personId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "onboardingFilter", "in": "query", "schema": { "type": "boolean" } }, { "name": "fullMaintenanceFilter", "in": "query", "schema": { "type": "boolean" } }, { "name": "scheduledFilter", "in": "query", "schema": { "type": "boolean" } }, { "name": "sessionType", "in": "query", "description": "The string or integer value may be used. Cloud = 1, Computer = 2, Person = 3", "schema": { "$ref": "#/components/schemas/SessionType" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeActions", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeStages", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeActionActivities", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/logs": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/old-logs": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/phases": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionPhaseResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionPhaseResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionPhaseResponse" } } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/last-log": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetMaintenanceSessionLogResponse" } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/cancel": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/cancel-all": { "post": { "tags": [ "MaintenanceSessions" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/cancel": { "post": { "tags": [ "MaintenanceSessions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CancelSessionsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CancelSessionsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSessionsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelSessionsRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/{sessionId}/rerun": { "post": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/maintenance-sessions/rerun": { "post": { "tags": [ "MaintenanceSessions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RerunSessionsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RerunSessionsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RerunSessionsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RerunSessionsRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/{sessionId}/resume": { "post": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/cancel-for-schedule/{scheduleId}": { "get": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-sessions/status-counts": { "get": { "tags": [ "MaintenanceSessions" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSessionStatusCountsPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionStatusCountsPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSessionStatusCountsPayload" } } } } } } }, "/api/v1/maintenance-sessions/{sessionId}/actions/{actionId}/rerun": { "post": { "tags": [ "MaintenanceSessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-tasks/{id}/authorization": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } }, "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } } }, "/api/v1/maintenance-tasks/global": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } } } } } }, "post": { "tags": [ "MaintenanceTasks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalMaintenanceTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalMaintenanceTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalMaintenanceTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalMaintenanceTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } } } } } }, "/api/v1/maintenance-tasks/local": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } } } } } }, "post": { "tags": [ "MaintenanceTasks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLocalMaintenanceTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalMaintenanceTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLocalMaintenanceTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLocalMaintenanceTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } } } } } }, "/api/v1/maintenance-tasks/local/{id}": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } } } } }, "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMaintenanceTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMaintenanceTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMaintenanceTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMaintenanceTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } } } } }, "delete": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-tasks/global/{id}": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } } } } }, "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMaintenanceTaskPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMaintenanceTaskPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMaintenanceTaskPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMaintenanceTaskPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalMaintenanceTaskResponse" } } } } } }, "delete": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/maintenance-tasks/reference-count": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "maintenanceTaskType", "in": "query", "description": "The string or integer value may be used. Global = 0, Local = 1", "schema": { "$ref": "#/components/schemas/DatabaseType" } }, { "name": "maintenanceTaskId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/maintenance-tasks/duplicate": { "post": { "tags": [ "MaintenanceTasks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DuplicateMaintenanceTaskRequestbody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateMaintenanceTaskRequestbody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DuplicateMaintenanceTaskRequestbody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DuplicateMaintenanceTaskRequestbody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalMaintenanceTaskResponse" } } } } } } }, "/api/v1/maintenance-tasks/search": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "globalOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "configurationTaskOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskSearchResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskSearchResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskSearchResult" } } } } } } } }, "/api/v1/maintenance-tasks/local/{id}/migrate-local-to-global-what-if": { "get": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } } } } } } }, "/api/v1/maintenance-tasks/local/{id}/migrate-local-to-global": { "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/maintenance-tasks/global/{id}/param-block-from-parameters": { "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/maintenance-tasks/local/{id}/param-block-from-parameters": { "post": { "tags": [ "MaintenanceTasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/maintenance-tasks/validate-param-block-parameters": { "post": { "tags": [ "MaintenanceTasks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultWithConvertedParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultWithConvertedParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResultWithConvertedParameters" } } } } } } }, "/api/v1/media/local/{id}/authorization": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } }, "post": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } } }, "/api/v1/media/requestFileDownloadUrl": { "post": { "tags": [ "Media" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetFileDownloadUrlRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFileDownloadUrlRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFileDownloadUrlRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetFileDownloadUrlRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/media/search": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "globalOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MediaSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaSearchResponse" } } } } } } }, "/api/v1/media/local": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "category", "in": "query", "description": "The string or integer value may be used. None = 0, SoftwareIcon = 1", "schema": { "$ref": "#/components/schemas/MediaCategory" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/media/local/{id}": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } } } } } }, "post": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMediaPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMediaPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMediaPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalMediaPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalMediaResponse" } } } } } }, "delete": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/media/local/upload": { "post": { "tags": [ "Media" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" }, "mediaCategory": { "$ref": "#/components/schemas/MediaCategory" }, "mediaId": { "type": "integer", "format": "int32" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" }, "mediaCategory": { "style": "form" }, "mediaId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/media/support/upload": { "post": { "tags": [ "Media" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/media/local/{id}/download-url": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/media/global": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "category", "in": "query", "description": "The string or integer value may be used. None = 0, SoftwareIcon = 1", "schema": { "$ref": "#/components/schemas/MediaCategory" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/media/global/{id}": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } } } } } }, "post": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMediaPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMediaPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMediaPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalMediaPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } } } } } }, "delete": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/media/global/upload": { "post": { "tags": [ "Media" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" }, "mediaCategory": { "$ref": "#/components/schemas/MediaCategory" }, "mediaId": { "type": "integer", "format": "int32" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" }, "mediaCategory": { "style": "form" }, "mediaId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalMediaResponse" } } } } } } }, "/api/v1/media/global/{id}/download-url": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/metrics/circuit-breakers": { "get": { "tags": [ "Metrics" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CircuitBreakerState" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CircuitBreakerState" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CircuitBreakerState" } } } } } } } }, "/api/v1/metrics/circuit-breakers/isolate": { "post": { "tags": [ "Metrics" ], "parameters": [ { "name": "policyName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/metrics/circuit-breakers/reset": { "post": { "tags": [ "Metrics" ], "parameters": [ { "name": "policyName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/metrics/provider-links": { "get": { "tags": [ "Metrics" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/notifications/dx": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } } } } }, "/api/v1/notifications/acknowledge": { "post": { "tags": [ "Notifications" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcknowledgeNotificationsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeNotificationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeNotificationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcknowledgeNotificationsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/notifications/unacknowledged": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } } } } }, "/api/v1/notifications/{type}/silence": { "post": { "tags": [ "Notifications" ], "parameters": [ { "name": "type", "in": "path", "description": "The string or integer value may be used. ProviderHealth = 1, AccessRequested = 2, LargeScriptOutput = 3, UnacknowledgedDeployments = 4, UpdateInstance = 5, ProviderAgentsRequiringManualDecision = 6, AzureTenantProblems = 7, AzureCustomerPreconsentFailed = 8, AzureMultiCustomerPreconsentFailed = 9, ChangeRequestCreatedOrUpdated = 10, ChangeRequestAcknowledged = 11, ProviderRecommendation = 12, FeatureUsageExceeded = 13, TenantDeletion = 14, ScheduleFailed = 15", "required": true, "schema": { "$ref": "#/components/schemas/NotificationType" } }, { "name": "objectId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } } } } } } }, "/api/v1/notifications": { "get": { "tags": [ "Notifications" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSilencedNotificationResponse" } } } } } } } }, "/api/v1/notifications/{id}/unsilence": { "delete": { "tags": [ "Notifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/oauth/begin-auth-code-flow": { "post": { "tags": [ "Oauth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BeginAuthCodeFlowResponse" } } } } } } }, "/api/v1/oauth/fail-auth-code-flow": { "post": { "tags": [ "Oauth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FailAuthCodeFlowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FailAuthCodeFlowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FailAuthCodeFlowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FailAuthCodeFlowRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/oauth/finish-auth-code-flow": { "post": { "tags": [ "Oauth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FinishAuthCodeFlowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FinishAuthCodeFlowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FinishAuthCodeFlowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FinishAuthCodeFlowRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/oauth/oauth-access-tokens": { "get": { "tags": [ "Oauth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } } } } } } } }, "/api/v1/oauth/oauth-access-tokens/{id}/{accessTokenId}": { "get": { "tags": [ "Oauth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accessTokenId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Oauth2AccessTokenWithTenantNameResponse" } } } } } } }, "/api/v1/oauth/oauth-access-tokens/{id}/refresh": { "post": { "tags": [ "Oauth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Oauth2AccessToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Oauth2AccessToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Oauth2AccessToken" } } } } } } }, "/api/v1/oauth/oauth-access-tokens/{id}": { "delete": { "tags": [ "Oauth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/persons/dx": { "get": { "tags": [ "Persons" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "tagId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeUserData", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "personType", "in": "query", "description": "The string or integer value may be used. All = 0, User = 1, Person = 2", "schema": { "$ref": "#/components/schemas/PersonType" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } } } } } } }, "/api/v1/persons": { "get": { "tags": [ "Persons" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } } } } } }, "post": { "tags": [ "Persons" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePersonPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePersonPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePersonPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } } } } } }, "/api/v1/persons/{id}": { "get": { "tags": [ "Persons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } } } } }, "delete": { "tags": [ "Persons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Persons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatePersonPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePersonPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePersonPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePersonPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSimplePersonResponse" } } } } } } }, "/api/v1/persons/requesting-access": { "get": { "tags": [ "Persons" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequestResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequestResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequestResponse" } } } } } } } }, "/api/v1/persons/{personId}/grant-access": { "post": { "tags": [ "Persons" ], "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GrantAccessRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrantAccessRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantAccessRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GrantAccessRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GrantAccessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrantAccessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantAccessResponse" } } } } } } }, "/api/v1/persons/{personId}/deny-access": { "post": { "tags": [ "Persons" ], "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } } } } } } }, "/api/v1/persons/add-tags": { "post": { "tags": [ "Persons" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/persons/remove-tags": { "post": { "tags": [ "Persons" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/persons/{id}/self-service": { "get": { "tags": [ "Persons" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } } } } } } }, "/api/v1/persons/{personId}/detected-software": { "get": { "tags": [ "Persons" ], "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } } } } } } }, "/api/v1/preferences": { "get": { "tags": [ "Preferences" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPreferencesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPreferencesResponse" } } } } } } }, "/api/v1/preferences/tenants/{tenantId}": { "get": { "tags": [ "Preferences" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } } } } } }, "patch": { "tags": [ "Preferences" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPreferencesOperation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPreferencesOperation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPreferencesOperation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPreferencesOperation" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPreferences" } } } } } } }, "/api/v1/preferences/application": { "patch": { "tags": [ "Preferences" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPreferencesOperation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPreferencesOperation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPreferencesOperation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPreferencesOperation" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationPreferences" } } } } } } }, "/api/v1/preferences/my": { "patch": { "tags": [ "Preferences" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPreferencesOperation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPreferencesOperation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPreferencesOperation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPreferencesOperation" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPreferences" } } } } } } }, "/api/v1/provider-agents/{agentId}/identification-logs": { "get": { "tags": [ "ProviderAgents" ], "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderAgentIdentificationLogResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderAgentIdentificationLogResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderAgentIdentificationLogResponse" } } } } } } } }, "/api/v1/provider-agents/bulk-delete-pending": { "post": { "tags": [ "ProviderAgents" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } } } } } } }, "/api/v1/provider-agents/pending": { "get": { "tags": [ "ProviderAgents" ], "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sortDesc", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includeOffline", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "providerLinkId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "agentFilter", "in": "query", "description": "The string or integer value may be used. All = 1, OnlyPendingIdentification = 2, OnlyIdentified = 3, RequiresManualDecision = 4, AssociatedToDeletedComputers = 5", "schema": { "$ref": "#/components/schemas/ProviderAgentFilter" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPendingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPendingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPendingResponse" } } } } } } }, "/api/v1/provider-agents/{computerId}/pending-conflicts": { "get": { "tags": [ "ProviderAgents" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetFailedPendingAgentResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetFailedPendingAgentResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetFailedPendingAgentResponse" } } } } } } } }, "/api/v1/provider-agents/resolve-failures": { "post": { "tags": [ "ProviderAgents" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResolveFailuresRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveFailuresRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveFailuresRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveFailuresRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-agents/{agentId}/resolve-failures": { "post": { "tags": [ "ProviderAgents" ], "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-agents/resolve-failure/{failureId}": { "post": { "tags": [ "ProviderAgents" ], "parameters": [ { "name": "failureId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "manualResolutionDecision", "in": "query", "description": "The string or integer value may be used. DeleteExisting = 0, GenerateNewDeviceId = 1, OverwriteExisting = 2", "schema": { "$ref": "#/components/schemas/AgentIdentificationManualResolutionDecision" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-agents/pending-counts": { "get": { "tags": [ "ProviderAgents" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPendingCountsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPendingCountsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPendingCountsResponse" } } } } } } }, "/api/v1/provider-agents/identify": { "post": { "tags": [ "ProviderAgents" ], "summary": "Identify agents that are marked with requiring manual identification", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IdentifyAgentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IdentifyAgentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IdentifyAgentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IdentifyAgentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/installer/agent-rekey/request": { "post": { "tags": [ "ProviderLinks" ], "responses": { "200": { "description": "OK" } } } }, "/plugins/api/v1/{providerLinkId}/{catchAll}": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "providerLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "catchAll", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "providerLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "catchAll", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "providerLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "catchAll", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/rmm-links": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "includeClients", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeUnlinkedClients", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "/api/v1/provider-links": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "includeClients", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeUnlinkedClients", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "/api/v1/rmm-links/{id}": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeClients", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includeProvidersLinkedFromThisProvider", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } }, "put": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "/api/v1/provider-links/{id}": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeClients", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includeProvidersLinkedFromThisProvider", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } }, "put": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProviderLinkRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } }, "delete": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/verify-with-external-provider-reference": { "post": { "tags": [ "ProviderLinks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/create-with-external-provider-reference": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "throwIfAgentInstallerVersionNotSet", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderLinkWithExternalProviderReferenceRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProviderLinkResponse" } } } } } } }, "/api/v1/provider-links/{id}/reload": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/tickets/{ticketId}": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TechnicianPageInfoFromPsaTicket" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TechnicianPageInfoFromPsaTicket" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TechnicianPageInfoFromPsaTicket" } } } } } } }, "/api/v1/provider-links/{id}/cross-references/{externalLinkId}/disable-client-linking": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "externalLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } } } } } } }, "/api/v1/provider-links/{id}/cross-references/{externalLinkId}/enable-client-linking": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "externalLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } } } } } } }, "/api/v1/provider-links/{id}/cross-references/{externalLinkId}/delete": { "delete": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "externalLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/cross-references/create": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLinkedProviderReferenceRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLinkedProviderReferenceRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLinkedProviderReferenceRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLinkedProviderReferenceRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkedExternalLink" } } } } } } }, "/api/v1/provider-links/{id}/cross-references/{externalLinkId}/sync-clients": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "externalLinkId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/clients/sync": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/clients/statuses": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientStatus" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientStatus" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientStatus" } } } } } } } }, "/api/v1/provider-links/{id}/clients/types": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientType" } } } } } } } }, "/api/v1/provider-links/{id}/clients": { "get": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderClientResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderClientResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderClientResponse" } } } } } } } }, "/api/v1/provider-links/{id}/clients/link-to-tenant": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LinkClientsToTenantRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkClientsToTenantRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkClientsToTenantRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkClientsToTenantRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/clients/auto-link-to-tenants": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkLinkClientsToTenantsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkLinkClientsToTenantsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkLinkClientsToTenantsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkLinkClientsToTenantsRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/clients/link-to-new-tenant": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantResponseBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantResponseBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkClientToNewTenantResponseBody" } } } } } } }, "/api/v1/provider-links/{id}/clients/link-exact-match-clients": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderClientLinkToTenantByExactNameResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderClientLinkToTenantByExactNameResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderClientLinkToTenantByExactNameResponse" } } } } } } } }, "/api/v1/provider-links/{id}/clients/unlink-from-tenants": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UnlinkClientsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkClientsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnlinkClientsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnlinkClientsRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/clients/sync-agents": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncAgentsForClientsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncAgentsForClientsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncAgentsForClientsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncAgentsForClientsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/agents/install-on-computer/{computerId}": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/agents/{agentId}/refresh-device-online-status": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/provider-links/{id}/agents/{agentId}/delete-offline-agent-from-computer": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-links/{id}/agents/provisioning-package-uri": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } } } } } } }, "/api/v1/provider-links/{id}/agents/executable-uri": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } } } } } } }, "/api/v1/provider-links/{id}/agents/executable-uri-with-onboarding": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParametersWithOnboardingOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParametersWithOnboardingOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParametersWithOnboardingOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetExecutableUriParametersWithOnboardingOptions" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } } } } } } }, "/api/v1/provider-links/{id}/agents/provisioning-package-uri-with-onboarding": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParametersWithOnboardingOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParametersWithOnboardingOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParametersWithOnboardingOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetProvisioningPackageUriParametersWithOnboardingOptions" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } } } } } } }, "/api/v1/provider-links/{id}/agents/powershell-install-script": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IScript" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IScript" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IScript" } } } } } } }, "/api/v1/provider-links/{id}/agents/powershell-install-script-with-onboarding": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParametersWithOnboardingOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParametersWithOnboardingOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParametersWithOnboardingOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetPowerShellInstallScriptParametersWithOnboardingOptions" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IScript" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IScript" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IScript" } } } } } } }, "/api/v1/provider-links/{id}/agents/bash-install-script": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IScript" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IScript" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IScript" } } } } } } }, "/api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParametersWithOnboardingOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParametersWithOnboardingOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParametersWithOnboardingOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetBashInstallScriptParametersWithOnboardingOptions" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IScript" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IScript" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IScript" } } } } } } }, "/api/v1/provider-links/{id}/agents/{computerId}/external-agent-url": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/provider-links/{id}/agents/sync": { "post": { "tags": [ "ProviderLinks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/provider-types/{providerType}/bind-parameters": { "post": { "tags": [ "ProviderTypes" ], "parameters": [ { "name": "providerType", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegrationBindParametersRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationBindParametersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationBindParametersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationBindParametersRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } } } } } } }, "/api/v1/provider-types": { "get": { "tags": [ "ProviderTypes" ], "parameters": [ { "name": "includeLinkFormSchemas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderTypeDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderTypeDto" } } } } } } } }, "/api/v1/provider-types/device-group-types/{deviceGroupTypeId}/device-groups": { "get": { "tags": [ "ProviderTypes" ], "parameters": [ { "name": "deviceGroupTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerLinkId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalClientId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IDeviceGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IDeviceGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IDeviceGroup" } } } } } } } }, "/api/v1/provider-types/client-group-types/{clientGroupTypeId}/client-groups": { "get": { "tags": [ "ProviderTypes" ], "parameters": [ { "name": "clientGroupTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerLinkId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IClientGroup" } } } } } } } }, "/api/v1/roles/{roleId}/assignments": { "get": { "tags": [ "Roles" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "RequireTotalCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "RequireGroupCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsCountQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsSummaryQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SortingInfo" } } }, { "name": "Group", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupingInfo" } } }, { "name": "Filter", "in": "query", "schema": { "type": "array", "items": { } } }, { "name": "TotalSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "GroupSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "Select", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PreSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RemoteSelect", "in": "query", "schema": { "type": "boolean" } }, { "name": "RemoteGrouping", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExpandLinqSumType", "in": "query", "schema": { "type": "boolean" } }, { "name": "PrimaryKey", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultSort", "in": "query", "schema": { "type": "string" } }, { "name": "StringToLower", "in": "query", "schema": { "type": "boolean" } }, { "name": "PaginateViaPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "SortByPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "AllowAsyncOverSync", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } } } } } } }, "/api/v1/roles": { "post": { "tags": [ "Roles" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } } } } } }, "get": { "tags": [ "Roles" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRoleResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRoleResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRoleResponse" } } } } } } } }, "/api/v1/roles/{roleId}": { "put": { "tags": [ "Roles" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } } } } } }, "get": { "tags": [ "Roles" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } } } } } }, "delete": { "tags": [ "Roles" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/roles/{roleId}/clone": { "post": { "tags": [ "Roles" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloneRoleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloneRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } } } } } } }, "/api/v1/roles/permissions": { "get": { "tags": [ "Roles" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ISubjectMetadata" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ISubjectMetadata" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ISubjectMetadata" } } } } } } } }, "/api/v1/schedules": { "get": { "tags": [ "Schedules" ], "parameters": [ { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScheduleResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScheduleResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScheduleResponse" } } } } } } }, "post": { "tags": [ "Schedules" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } } } } } } }, "/api/v1/schedules/{scheduleId}": { "get": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } } } } } }, "put": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } } } } } }, "delete": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/schedules/{scheduleId}/run-now": { "post": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/schedules/running-schedule-ids": { "get": { "tags": [ "Schedules" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } } } }, "/api/v1/schedules/{scheduleId}/cancel": { "post": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/schedules/{scheduleId}/duplicate": { "post": { "tags": [ "Schedules" ], "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScheduleResponse" } } } } } } }, "/api/v1/schedules/bulk-update-status": { "patch": { "tags": [ "Schedules" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } } } } } } }, "/api/v1/schedules/bulk-run-now": { "post": { "tags": [ "Schedules" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } } } } } } }, "/api/v1/schedules/bulk-delete": { "post": { "tags": [ "Schedules" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } } } } } } }, "/api/v1/schedules/bulk-cancel": { "post": { "tags": [ "Schedules" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkScheduleOperationResult" } } } } } } } }, "/api/v1/scripts/local/{scriptId}/authorization": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } }, "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } } }, "/api/v1/scripts/debug/cancel/{cancellationId}": { "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "cancellationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/language-service/start": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StartEditorServicesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StartEditorServicesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartEditorServicesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StartEditorServicesRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/language-service/{terminalId}/language": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "terminalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/run-adhoc-metascript": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RunAdHocMetascriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunAdHocMetascriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunAdHocMetascriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunAdHocMetascriptRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/run": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RunScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunScriptRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/dx": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "databaseType", "in": "query", "description": "The string or integer value may be used. Global = 0, Local = 1", "schema": { "$ref": "#/components/schemas/DatabaseType" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadResult" } } } } } } }, "/api/v1/scripts/global/names": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "searchFilter", "in": "query", "schema": { "type": "string" } }, { "name": "scriptCategory", "in": "query", "description": "The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13", "schema": { "$ref": "#/components/schemas/ScriptCategory" } }, { "name": "searchType", "in": "query", "schema": { "type": "string", "default": "Name and Content" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } } } } } } }, "/api/v1/scripts/local/names": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "searchFilter", "in": "query", "schema": { "type": "string" } }, { "name": "scriptCategory", "in": "query", "description": "The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13", "schema": { "$ref": "#/components/schemas/ScriptCategory" } }, { "name": "searchType", "in": "query", "schema": { "type": "string", "default": "Name and Content" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetScriptNameResponse" } } } } } } } }, "/api/v1/scripts/search": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "globalOnly", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "localOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptSearchResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptSearchResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptSearchResult" } } } } } } } }, "/api/v1/scripts/local": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } } } } } }, "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "ignoreSyntaxErrors", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLocalScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLocalScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLocalScriptRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } } } } } }, "/api/v1/scripts/global": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } } } } } }, "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "ignoreSyntaxErrors", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalScriptRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } } } } } }, "/api/v1/scripts/local/{scriptId}": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } } } } }, "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ignoreSyntaxErrors", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalScriptRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } } } } }, "delete": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/global/{scriptId}": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } } } } }, "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ignoreSyntaxErrors", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalScriptRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalScriptResponse" } } } } } }, "delete": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/scripts/syntax-check": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScriptSyntaxCheckRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptSyntaxCheckRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptSyntaxCheckRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScriptSyntaxCheckRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SyntaxCheckerResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyntaxCheckerResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyntaxCheckerResult" } } } } } } }, "/api/v1/scripts/references/count": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptType", "in": "query", "description": "The string or integer value may be used. Global = 0, Local = 1", "schema": { "$ref": "#/components/schemas/DatabaseType" } }, { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptReferenceCounts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptReferenceCounts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptReferenceCounts" } } } } } } }, "/api/v1/scripts/global/{scriptId}/references": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } } } } } } }, "/api/v1/scripts/local/{scriptId}/references": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptReference" } } } } } } } }, "/api/v1/scripts/duplicate": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DuplicateScriptRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateScriptRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DuplicateScriptRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DuplicateScriptRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalScriptResponse" } } } } } } }, "/api/v1/scripts/local/{scriptId}/migrate-local-to-global-what-if": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } } } } } } }, "/api/v1/scripts/local/{scriptId}/migrate-local-to-global": { "post": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/scripts/default-variables": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetScriptVariablesAndParametersResponse" } } } } } } }, "/api/v1/scripts/functions": { "get": { "tags": [ "Scripts" ], "summary": "Execute a cloud script that returns results of Get-Command", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetCommandResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetCommandResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetCommandResult" } } } } } } } }, "/api/v1/scripts/functions/syntax": { "post": { "tags": [ "Scripts" ], "summary": "Execute a cloud script that returns the syntax for a specific command", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetFunctionSyntaxRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFunctionSyntaxRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFunctionSyntaxRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetFunctionSyntaxRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/scripts/validate-param-block-parameters": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromScriptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromScriptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromScriptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateParamBlockParametersFromScriptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicFormBindResult" } } } } } } }, "/api/v1/scripts/does-script-have-param-block": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DoesScriptHaveParamBlockRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DoesScriptHaveParamBlockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DoesScriptHaveParamBlockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DoesScriptHaveParamBlockRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/scripts/disabled-preflight-scripts": { "get": { "tags": [ "Scripts" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisabledPreflightScriptResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisabledPreflightScriptResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisabledPreflightScriptResponse" } } } } } } } }, "/api/v1/scripts/set-preflight-script-enablement": { "post": { "tags": [ "Scripts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetPreflightScriptEnablementRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetPreflightScriptEnablementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPreflightScriptEnablementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPreflightScriptEnablementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/api/v1/scripts/local/{scriptId}/audit": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } } } } } } }, "/api/v1/scripts/global/{scriptId}/audit": { "get": { "tags": [ "Scripts" ], "parameters": [ { "name": "scriptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptActionAuditResult" } } } } } } }, "/api/v1/smtp-configs": { "get": { "tags": [ "SmtpConfig" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } } } } } }, "post": { "tags": [ "SmtpConfig" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } } } } } }, "/api/v1/smtp-configs/{tenantId}": { "get": { "tags": [ "SmtpConfig" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } } } } }, "post": { "tags": [ "SmtpConfig" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSmtpRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSmtpConfigResponse" } } } } } }, "delete": { "tags": [ "SmtpConfig" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/smtp-configs/send-test-email": { "post": { "tags": [ "SmtpConfig" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendTestEmailRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendTestEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendTestEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendTestEmailRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}/authorization": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } }, "post": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}/migrate-local-to-global-what-if": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrationPreviewResponse" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}/migrate-local-to-global": { "post": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/software/local": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } } } } } }, "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } } } } }, "patch": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } } } } }, "delete": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/software/global": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } } } } } }, "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } } } } } }, "/api/v1/software/global/{softwareIdentifier}": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } } } } }, "patch": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } } } } }, "delete": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/software/local/{softwareIdentifier}/versions": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } } } } } }, "post": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLocalSoftwareVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}/versions/{semanticVersion}": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } } } } }, "patch": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalSoftwareVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } } } } }, "delete": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/software/local/{softwareIdentifier}/latest": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" } } } } } } }, "/api/v1/software/local/upload": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } } } } } } }, "/api/v1/software/local/{softwareIdentifier}/versions/{semanticVersion}/request-download": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/software/local/fast-create": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FastCreateLocalVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FastCreateLocalVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FastCreateLocalVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FastCreateLocalVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" } } } } } } }, "/api/v1/software/local/analyze": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnalyzeLocalSoftwarePackageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeLocalSoftwarePackageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzeLocalSoftwarePackageResponse" } } } } } } }, "/api/v1/software/global/{softwareIdentifier}/versions": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } } } } } }, "post": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalSoftwareVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } } } } } }, "/api/v1/software/global/{softwareIdentifier}/versions/{semanticVersion}": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } } } } }, "patch": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalSoftwareVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } } } } }, "delete": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/software/global/{softwareIdentifier}/latest": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" } } } } } } }, "/api/v1/software/global/upload": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "chunkMetadata": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "chunkMetadata": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareFileUploadData" } } } } } } }, "/api/v1/software/global/{softwareIdentifier}/versions/{semanticVersion}/request-download": { "get": { "tags": [ "Software" ], "parameters": [ { "name": "softwareIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "semanticVersion", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SemanticVersion" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/software/global/fast-create": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FastCreateGlobalVersionRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FastCreateGlobalVersionRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FastCreateGlobalVersionRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FastCreateGlobalVersionRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" } } } } } } }, "/api/v1/software/global/analyze": { "post": { "tags": [ "Software" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AnalyzePackageParams" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnalyzeGlobalSoftwarePackageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeGlobalSoftwarePackageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzeGlobalSoftwarePackageResponse" } } } } } } }, "/api/v1/syncs/trigger-user-affinity-sync": { "post": { "tags": [ "Syncs" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/syncs/azure-user-sync": { "post": { "tags": [ "Syncs" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/releases": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReleasesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReleasesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReleasesResponse" } } } } } } }, "/api/v1/system/pull-update": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/timezones": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZoneResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZoneResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZoneResource" } } } } } } } }, "/api/v1/system/restart-backend": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/update-release-channel": { "post": { "tags": [ "System" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReleaseChannelRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReleaseChannelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReleaseChannelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReleaseChannelRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/immy-support-access-grant-details": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MspInstanceImmySupportAccessGrantDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MspInstanceImmySupportAccessGrantDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MspInstanceImmySupportAccessGrantDetails" } } } } } } }, "/api/v1/system/request-session-support": { "post": { "tags": [ "System" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RequestSessionSupportRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RequestSessionSupportRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestSessionSupportRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestSessionSupportRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/request-form-support": { "post": { "tags": [ "System" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RequestFormSupportBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RequestFormSupportBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestFormSupportBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestFormSupportBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/is-immy-support-access-granted": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/system/enable-immy-support-access": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/system/disable-immy-support-access": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tags/{tagId}/authorization": { "get": { "tags": [ "Tags" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } }, "post": { "tags": [ "Tags" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetailsUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizationDetails" } } } } } } }, "/api/v1/tags": { "get": { "tags": [ "Tags" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "orderByUpdatedDate", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTagResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTagResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTagResponse" } } } } } } }, "post": { "tags": [ "Tags" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTagPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTagPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTagPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } } } } } } }, "/api/v1/tags/{tagId}": { "get": { "tags": [ "Tags" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } } } } } }, "post": { "tags": [ "Tags" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateTagPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTagPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTagPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTagResponse" } } } } } }, "delete": { "tags": [ "Tags" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments/change-request/{changeRequestId}/diff": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "changeRequestId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestDiff" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestDiff" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestDiff" } } } } } } }, "/api/v1/target-assignments/{deploymentId}/change-request": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "deploymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } }, "/api/v1/target-assignments/{deploymentId}/change-request/{changeRequestId}": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "deploymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "changeRequestId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } }, "/api/v1/target-assignments/change-request/{changeRequestId}": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "changeRequestId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } }, "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "changeRequestId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } }, "/api/v1/target-assignments/change-requests": { "get": { "tags": [ "TargetAssignments" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } } }, "/api/v1/target-assignments/{deploymentId}/change-requests": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "deploymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } } }, "/api/v1/target-assignments/change-request": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTargetAssignmentChangeRequestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestResponse" } } } } } } }, "/api/v1/target-assignments/maintenance-item-orders": { "get": { "tags": [ "TargetAssignments" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceItemOrder" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceItemOrder" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceItemOrder" } } } } } } } }, "/api/v1/target-assignments/update-maintenance-item-order": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMaintenanceItemOrderPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMaintenanceItemOrderPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMaintenanceItemOrderPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMaintenanceItemOrderPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MaintenanceItemOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItemOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItemOrder" } } } } } } }, "/api/v1/target-assignments/recommended-approvals": { "get": { "tags": [ "TargetAssignments" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } } } } } } }, "/api/v1/target-assignments/recommended-approvals/update": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateRecommendedApprovalsRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRecommendedApprovalsRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRecommendedApprovalsRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRecommendedApprovalsRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecommendedApprovalResponse" } } } } } } } }, "/api/v1/target-assignments/optional-target-assignment-approvals/computer/{computerId}": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "computerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOptionalTargetAssignmentApprovalResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOptionalTargetAssignmentApprovalResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetOptionalTargetAssignmentApprovalResponse" } } } } } } } }, "/api/v1/target-assignments/optional-target-assignment-approvals/{id}": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateOptionalTargetAssignmentApprovalPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOptionalTargetAssignmentApprovalPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOptionalTargetAssignmentApprovalPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOptionalTargetAssignmentApprovalPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v1/target-assignments/global/{id}/notes": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments/global": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } } } } } } }, "/api/v1/target-assignments/global/{id}": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } } } } }, "put": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGlobalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } } } } }, "delete": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments/global/{id}/type": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } } } } } } }, "/api/v1/target-assignments/global/create": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalTargetAssignmentResource" } } } } } } }, "/api/v1/target-assignments/{id}/notes": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNotesPayload" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } } }, "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLocalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLocalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLocalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } } }, "/api/v1/target-assignments/batch-update": { "patch": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAssignmentRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments/duplicates": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DuplicateTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DuplicateTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DuplicateTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TargetAssignmentDuplicateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TargetAssignmentDuplicateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TargetAssignmentDuplicateResponse" } } } } } } }, "/api/v1/target-assignments/{id}": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } }, "put": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLocalTargetAssignmentPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } }, "delete": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/target-assignments/visibility": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResolveVisibilityTargetAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveVisibilityTargetAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveVisibilityTargetAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveVisibilityTargetAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" } } } } } } } }, "/api/v1/target-assignments/tenant-target-preview": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } } }, "/api/v1/target-assignments/target-preview": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CalculateTargetedComputerResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetedComputerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetedComputerResponse" } } } } } } }, "/api/v1/target-assignments/persons-target-preview": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalculateTargetsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetedPerson" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetedPerson" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetedPerson" } } } } } } } }, "/api/v1/target-assignments/{id}/type": { "get": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTargetAssignmentTypeResponse" } } } } } } }, "/api/v1/target-assignments/{id}/override": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } } }, "/api/v1/target-assignments/global/{id}/override": { "post": { "tags": [ "TargetAssignments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OverrideTargetAssignmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" } } } } } } }, "/api/v1/target-assignments/duplicate": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DuplicateAssignmentRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateAssignmentRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DuplicateAssignmentRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DuplicateAssignmentRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/target-assignments/migrate-to-superseding-assignment": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Int32OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Int32OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Int32OpResult" } } } } } } }, "/api/v1/target-assignments/migrate-to-superseding-assignment-what-if": { "post": { "tags": [ "TargetAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentWhatIfResponseOpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentWhatIfResponseOpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentWhatIfResponseOpResult" } } } } } } }, "/api/v1/target-assignments/migrate-deployments-to-provider-links": { "post": { "tags": [ "TargetAssignments" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "mspOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } }, "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } }, "/api/v1/tenants/software-from-inventory/{id}": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantSoftwareFromInventoryResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantSoftwareFromInventoryResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantSoftwareFromInventoryResponse" } } } } } } } }, "/api/v1/tenants/software-from-inventory/export": { "get": { "tags": [ "Tenants" ], "summary": "Streams the contents of the detected computer software table as a CSV file to the client", "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/software-from-inventory/dx": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "loadOptions", "in": "query", "schema": { "$ref": "#/components/schemas/DataSourceLoadOptions" } }, { "name": "tenantId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftwareResponse" } } } } } } } }, "/api/v1/tenants/{id}": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } }, "put": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateTenantPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenantPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } }, "/api/v1/tenants/update-azure-tenant-link": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantLinkRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAzureTenantLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } }, "/api/v1/tenants/bulk-create": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkCreateTenantRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateTenantRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkCreateTenantRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkCreateTenantRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } } }, "/api/v1/tenants/bulk-delete": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteTenantsCmdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTenantsCmdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteTenantsCmdResponse" } } } } } } }, "/api/v1/tenants/bulk-merge": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MergeTenantsPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MergeTenantsPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MergeTenantsPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MergeTenantsPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResult" } } } } } } }, "/api/v1/tenants/activate/{id}": { "patch": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/deactivate/{id}": { "patch": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/{id}/azure-groups": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetAzureGroupResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetAzureGroupResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetAzureGroupResponse" } } } } } } } }, "/api/v1/tenants/{id}/azure-groups/{groupId}": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetAzureGroupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetAzureGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetAzureGroupResponse" } } } } } } }, "/api/v1/tenants/{id}/computers/excluded-from-maintenance": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerNameResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerNameResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerNameResponse" } } } } } } } }, "/api/v1/tenants/add-tags": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/remove-tags": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveTagsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/set-parent-tenant": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetParentTenantRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetParentTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetParentTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetParentTenantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/remove-parent-tenant": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveParentTenantRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveParentTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveParentTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveParentTenantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/tenants/resolve-assignments-for-maintenance-item": { "post": { "tags": [ "Tenants" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemResult" } } } } } } }, "/api/v1/tenants/computer-counts": { "get": { "tags": [ "Tenants" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantComputerCountResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantComputerCountResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantComputerCountResponse" } } } } } } } }, "/api/v1/tenants/excluded-from-cross-tenant-deployments": { "get": { "tags": [ "Tenants" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetTenantResponse" } } } } } } } }, "/auth/me": { "get": { "tags": [ "UserAuth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserAuthInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserAuthInfo" } } } } } } }, "/auth/refresh": { "get": { "tags": [ "UserAuth" ], "responses": { "200": { "description": "OK" } } } }, "/auth/login": { "get": { "tags": [ "UserAuth" ], "parameters": [ { "name": "redirectUrl", "in": "query", "schema": { "type": "string" } }, { "name": "prompt", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/auth/logout": { "get": { "tags": [ "UserAuth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/user-role-assignments": { "get": { "tags": [ "UserRoleAssignments" ], "parameters": [ { "name": "RequireTotalCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "RequireGroupCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsCountQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsSummaryQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SortingInfo" } } }, { "name": "Group", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupingInfo" } } }, { "name": "Filter", "in": "query", "schema": { "type": "array", "items": { } } }, { "name": "TotalSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "GroupSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "Select", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PreSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RemoteSelect", "in": "query", "schema": { "type": "boolean" } }, { "name": "RemoteGrouping", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExpandLinqSumType", "in": "query", "schema": { "type": "boolean" } }, { "name": "PrimaryKey", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultSort", "in": "query", "schema": { "type": "string" } }, { "name": "StringToLower", "in": "query", "schema": { "type": "boolean" } }, { "name": "PaginateViaPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "SortByPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "AllowAsyncOverSync", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } } } } } } }, "/api/v1/user-role-assignments/users/{userId}": { "get": { "tags": [ "UserRoleAssignments" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "RequireTotalCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "RequireGroupCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsCountQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsSummaryQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SortingInfo" } } }, { "name": "Group", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupingInfo" } } }, { "name": "Filter", "in": "query", "schema": { "type": "array", "items": { } } }, { "name": "TotalSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "GroupSummary", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" } } }, { "name": "Select", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PreSelect", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "RemoteSelect", "in": "query", "schema": { "type": "boolean" } }, { "name": "RemoteGrouping", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExpandLinqSumType", "in": "query", "schema": { "type": "boolean" } }, { "name": "PrimaryKey", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultSort", "in": "query", "schema": { "type": "string" } }, { "name": "StringToLower", "in": "query", "schema": { "type": "boolean" } }, { "name": "PaginateViaPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "SortByPrimaryKey", "in": "query", "schema": { "type": "boolean" } }, { "name": "AllowAsyncOverSync", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" } } } } } } } }, "/api/v1/user-role-assignments/users/{userId}/count": { "get": { "tags": [ "UserRoleAssignments" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/v1/user-role-assignments/owner/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOwnerAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOwnerAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOwnerAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOwnerAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/msp/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMspAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMspAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMspAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMspAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/tenant-tag/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTenantTagAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantTagAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTenantTagAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTenantTagAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/specific-tenant/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSpecificTenantAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpecificTenantAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSpecificTenantAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSpecificTenantAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/user-tenant/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserTenantAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserTenantAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserTenantAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserTenantAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/tag-resource/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTagResourceAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagResourceAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTagResourceAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTagResourceAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/category-resource/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCategoryResourceAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryResourceAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryResourceAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCategoryResourceAssignmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/specific-resource/create": { "post": { "tags": [ "UserRoleAssignments" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSpecificResourceAssignmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpecificResourceAssignmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSpecificResourceAssignmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSpecificResourceAssignmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } } } } }, "/api/v1/user-role-assignments/delete": { "delete": { "tags": [ "UserRoleAssignments" ], "parameters": [ { "name": "userRoleAssignmentIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/users": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "Filters", "in": "query", "schema": { "type": "string" } }, { "name": "Sorts", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserResponse" } } } } } } } }, "/api/v1/users/{userId}": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } } } } } }, "post": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } } } } } }, "delete": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/users/bulk-create": { "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserFromPersonRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserFromPersonRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserFromPersonRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserFromPersonRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateUsersFromPersonIdsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersFromPersonIdsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUsersFromPersonIdsResponse" } } } } } } }, "/api/v1/users/bulk-delete": { "delete": { "tags": [ "Users" ], "parameters": [ { "name": "userIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/users/submit-feedback": { "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubmitFeedbackRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubmitFeedbackRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitFeedbackRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitFeedbackRequestBody" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/users/{userId}/impersonate": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ImpersonationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImpersonationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImpersonationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImpersonationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/api/v1/users/stop-impersonating": { "post": { "tags": [ "Users" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpResult" } } } } } } }, "/api/v1/users/claims": { "get": { "tags": [ "Users" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetClaimsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetClaimsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetClaimsResponse" } } } } } } }, "/api/v1/users/invalidate-cache": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/users/update-expiration": { "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateExpirationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExpirationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateExpirationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateExpirationRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/users/{userId}/groups": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" } } } } } } } }, "/api/v1/webhooks/{id}": { "get": { "tags": [ "WebHook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "WebHook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AccessRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "personId": { "type": "integer", "format": "int32" }, "dateRequestedUTC": { "type": "string", "format": "date-time" }, "dateAcknowledgedUTC": { "type": "string", "format": "date-time", "nullable": true }, "acknowledgedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "granted": { "type": "boolean" }, "isAdmin": { "type": "boolean", "nullable": true }, "expirationTime": { "$ref": "#/components/schemas/ExpirationTime" }, "message": { "type": "string", "nullable": true }, "person": { "$ref": "#/components/schemas/Person" }, "acknowledgedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "AccessRequestResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "personId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string", "nullable": true }, "azurePrincipalId": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "dateRequestedUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AccessTokenSource": { "enum": [ "Obo", "DefaultAppRegistration", "CustomAppRegistration", "OboPartnerCenter" ], "type": "string", "description": "The string or integer value may be used. Obo = 1, DefaultAppRegistration = 2, CustomAppRegistration = 3, OboPartnerCenter = 4" }, "AcknowledgeNotificationsRequest": { "type": "object", "properties": { "notificationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ActionPreference": { "enum": [ "SilentlyContinue", "Stop", "Continue", "Inquire", "Ignore", "Suspend", "Break" ], "type": "string", "description": "The string or integer value may be used. SilentlyContinue = 0, Stop = 1, Continue = 2, Inquire = 3, Ignore = 4, Suspend = 5, Break = 6" }, "ActionProgressPhaseName": { "enum": [ "DetectInstalledAgentVersion", "UpdateAgentVersion", "VerifyAgentVersionUpdated", "DetectInstalledVersion", "DetermineDesiredVersion", "TestSoftware", "CheckForSoftwareLicense", "AddConfigTask", "TestTask", "MonitorTask", "AuditTask", "FetchDesiredVersion", "EnforceTask", "ApplyWindowsPatch", "DownloadConfigTaskFiles", "FetchDependentVersion", "InstallDependentVersion", "InstallSoftware", "RunUpgradeSoftwareScript", "UninstallSoftware", "RepairSoftware", "DownloadInstaller", "PostUninstallSoftware", "PostInstallSoftware", "TestTaskBeforeExecution", "TestSoftwareAfterExecution", "VerifyTask", "VerifySoftwareIsInDesiredState" ], "type": "string", "description": "The string or integer value may be used. DetectInstalledAgentVersion = 0, UpdateAgentVersion = 1, VerifyAgentVersionUpdated = 2, DetectInstalledVersion = 200, DetermineDesiredVersion = 201, TestSoftware = 202, CheckForSoftwareLicense = 203, AddConfigTask = 204, TestTask = 205, MonitorTask = 206, AuditTask = 207, FetchDesiredVersion = 301, EnforceTask = 302, ApplyWindowsPatch = 305, DownloadConfigTaskFiles = 306, FetchDependentVersion = 307, InstallDependentVersion = 308, InstallSoftware = 309, RunUpgradeSoftwareScript = 310, UninstallSoftware = 311, RepairSoftware = 313, DownloadInstaller = 314, PostUninstallSoftware = 315, PostInstallSoftware = 316, TestTaskBeforeExecution = 317, TestSoftwareAfterExecution = 318, VerifyTask = 319, VerifySoftwareIsInDesiredState = 320" }, "ActionToPerform": { "enum": [ "Install", "Uninstall", "Fail" ], "type": "string", "description": "The string or integer value may be used. Install = 0, Uninstall = 1, Fail = 2" }, "ActiveSession": { "type": "object", "properties": { "maintenanceSessionId": { "type": "integer", "format": "int32" }, "sessionStatus": { "$ref": "#/components/schemas/SessionStatus" }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" } }, "additionalProperties": false }, "AddChangeRequestCommentBody": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddTagsRequest": { "type": "object", "properties": { "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AddUserToGroupRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AddUsersToGroupRequest": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AgentIdentificationFailure": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "pendingAgentId": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "existingAgentId": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true }, "resolved": { "type": "boolean" }, "manualResolutionDecision": { "$ref": "#/components/schemas/AgentIdentificationManualResolutionDecision" }, "requiresManualResolution": { "type": "boolean" }, "unsupportedDeviceType": { "type": "boolean" }, "featureUsageExceeded": { "type": "boolean" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "pendingAgent": { "$ref": "#/components/schemas/ProviderAgent" }, "computer": { "$ref": "#/components/schemas/Computer" } }, "additionalProperties": false }, "AgentIdentificationLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "providerAgentId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "logType": { "$ref": "#/components/schemas/AgentIdentificationLogType" }, "timeUtc": { "type": "string", "format": "date-time" }, "providerAgent": { "$ref": "#/components/schemas/ProviderAgent" } }, "additionalProperties": false }, "AgentIdentificationLogType": { "enum": [ "Verbose", "Error" ], "type": "string", "description": "The string or integer value may be used. Verbose = 1, Error = 2" }, "AgentIdentificationManualResolutionDecision": { "enum": [ "DeleteExisting", "GenerateNewDeviceId", "OverwriteExisting" ], "type": "string", "description": "The string or integer value may be used. DeleteExisting = 0, GenerateNewDeviceId = 1, OverwriteExisting = 2" }, "AgentInstallationDetails": { "type": "object", "properties": { "isServicePresent": { "type": "boolean" }, "isApplicationRegistryEntryPresent": { "type": "boolean" }, "isServiceRunning": { "type": "boolean" }, "runningBinaryVersion": { "type": "string", "nullable": true }, "detectedInstalledVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentOnboardingOptions": { "type": "object", "properties": { "automaticallyOnboard": { "type": "boolean" }, "onboardingCorrelationId": { "type": "string", "nullable": true }, "onboardingSessionRebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "onboardingSessionPromptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "onboardingSessionAutoConsentToReboots": { "type": "boolean" }, "onboardingSessionPromptTimeoutMinutes": { "type": "integer", "format": "int32" }, "onboardingSessionSendFollowUpEmail": { "type": "boolean" }, "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true }, "additionalPersonIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isDevLab": { "type": "boolean" } }, "additionalProperties": false }, "AgentStartupInfo": { "type": "object", "properties": { "pid": { "type": "integer", "format": "int32" }, "installedAgentState": { "$ref": "#/components/schemas/AgentInstallationDetails" } }, "additionalProperties": false }, "AgentStatusDto": { "required": [ "agentId", "isConnected", "providerLinkId", "version" ], "type": "object", "properties": { "agentId": { "type": "integer", "format": "int32" }, "providerLinkId": { "type": "integer", "format": "int32" }, "isConnected": { "type": "boolean" }, "version": { "$ref": "#/components/schemas/SemanticVersion" }, "lastUpdatedUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AgentUpdateFormSchema": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/AgentUpdateFormSchemaInput" }, "nullable": true } }, "additionalProperties": false }, "AgentUpdateFormSchemaInput": { "required": [ "default", "description", "deviceGroupTypeId", "label", "name", "required", "type" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "default": { "nullable": true }, "deviceGroupTypeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AnalyzeGlobalSoftwarePackageResponse": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "displayVersion": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "upgradeCode": { "type": "string", "format": "uuid", "nullable": true }, "productCode": { "type": "string", "format": "uuid", "nullable": true }, "isExe": { "type": "boolean", "readOnly": true }, "isMsi": { "type": "boolean", "readOnly": true }, "powerShellInstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "batchInstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "powerShellUninstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "detectionScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "defaultPowershellUninstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" } }, "additionalProperties": false }, "AnalyzeLocalSoftwarePackageResponse": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "displayVersion": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "upgradeCode": { "type": "string", "format": "uuid", "nullable": true }, "productCode": { "type": "string", "format": "uuid", "nullable": true }, "isExe": { "type": "boolean", "readOnly": true }, "isMsi": { "type": "boolean", "readOnly": true }, "powerShellInstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "batchInstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "powerShellUninstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "detectionScript": { "$ref": "#/components/schemas/IScriptDetailsBase" }, "defaultPowershellUninstallScript": { "$ref": "#/components/schemas/IScriptDetailsBase" } }, "additionalProperties": false }, "AnalyzePackageParams": { "type": "object", "properties": { "blobName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiResponseErrorContent": { "type": "object", "properties": { "httpMethod": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppRegistrationOption": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppRegistrationType": { "enum": [ "Backend", "Custom" ], "type": "string", "description": "The string or integer value may be used. Backend = 0, Custom = 1" }, "ApplicationLockCallerInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "isLockHolder": { "type": "boolean" }, "since": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApplicationLockEventEventStream": { "type": "object", "additionalProperties": false }, "ApplicationLocksResponse": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "lockHolder": { "$ref": "#/components/schemas/ApplicationLockCallerInfo" }, "lockWaiters": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationLockCallerInfo" }, "nullable": true } }, "additionalProperties": false }, "ApplicationPreferences": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "enableOnboarding": { "type": "boolean" }, "enableAzureUserSync": { "type": "boolean" }, "defaultEmailBccList": { "$ref": "#/components/schemas/DefaultEmailBccList" }, "enableNiniteIntegration": { "type": "boolean" }, "defaultBrandingId": { "type": "integer", "format": "int32", "nullable": true }, "enableUserAffinitySync": { "type": "boolean" }, "enableSessionEmails": { "type": "boolean" }, "defaultBranding": { "$ref": "#/components/schemas/Branding" }, "defaultScriptTimeouts": { "$ref": "#/components/schemas/DefaultScriptTimeouts" }, "useImmyBotChocolateyFeed": { "type": "boolean" }, "hideChocolateyPackages": { "type": "boolean" }, "overwriteExistingDeviceIfOSIsNew": { "type": "boolean" }, "enableNonEssentialDeviceInventory": { "type": "boolean" }, "requireConsentForExternalSessionProviders": { "type": "boolean" }, "allowNonAdminsToManageAssignments": { "type": "boolean", "deprecated": true }, "showGettingStartedWizard": { "type": "boolean" }, "enableHistoricalInventory": { "type": "boolean" }, "defaultTimeZone": { "type": "string", "nullable": true }, "immyScriptPath": { "type": "string", "nullable": true }, "enableRequestAccess": { "type": "boolean" }, "enableEphemeralAgentDebugMode": { "type": "boolean", "deprecated": true }, "staleComputersLastAgentConnectionAgeDays": { "type": "integer", "format": "int32" }, "allowNonAdminsAndNonMspUsersToUseTerminalsAndEditScripts": { "type": "boolean", "deprecated": true }, "enablePreflightScripts": { "type": "boolean" }, "enableImmyBotRemoteControl": { "type": "boolean" }, "enableImmyBotRemoteControlRecording": { "type": "boolean" }, "enableProviderAuditLogging": { "type": "boolean" }, "providerAuditLogRetentionMonths": { "type": "integer", "format": "int32" }, "mspNonAdminsRequireChangeRequestsForCrossTenantDeployments": { "type": "boolean", "deprecated": true }, "enableMaintenanceActionActivities": { "type": "boolean" }, "enableAutomaticImmyBotReleaseUpdates": { "type": "boolean" }, "automaticImmyBotReleaseUpdateHour": { "type": "integer", "format": "int32" }, "daysToWaitBeforeAutomaticImmyBotUpdate": { "type": "integer", "format": "int32" }, "runScheduledInventoryAsMaintenanceSessions": { "type": "boolean" }, "enableBetaDynamicIntegrationMigrations": { "type": "boolean" }, "enableUserImpersonation": { "type": "boolean" }, "disconnectLeastActiveEditorServiceWhenLimitReached": { "type": "boolean" } }, "additionalProperties": false }, "ApplicationPreferencesOperation": { "type": "object", "properties": { "operationType": { "$ref": "#/components/schemas/OperationType" }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "Architecture": { "enum": [ "X86", "X64", "Arm", "Arm64", "Wasm", "S390x", "LoongArch64", "Armv6", "Ppc64le", "RiscV64" ], "type": "string", "description": "The string or integer value may be used. X86 = 0, X64 = 1, Arm = 2, Arm64 = 3, Wasm = 4, S390x = 5, LoongArch64 = 6, Armv6 = 7, Ppc64le = 8, RiscV64 = 9" }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "Audit": { "required": [ "dateTimeUtc", "objectName", "objectType", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "userAzureId": { "type": "string", "nullable": true }, "userDisplayName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "objectType": { "type": "string", "nullable": true }, "objectName": { "type": "string", "nullable": true }, "dateTimeUtc": { "type": "string", "format": "date-time" }, "oldValues": { "type": "string", "nullable": true }, "newValues": { "type": "string", "nullable": true }, "affectedProperties": { "type": "string", "nullable": true }, "primaryKey": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuditPropertyChange": { "type": "object", "properties": { "property": { "type": "string", "nullable": true }, "oldValue": { "nullable": true }, "newValue": { "nullable": true } }, "additionalProperties": false }, "AuthorizationDetails": { "required": [ "authorizedViewerTenants", "ownerTenantId", "ownerTenantName", "visibleToAllTenants" ], "type": "object", "properties": { "ownerTenantId": { "type": "integer", "format": "int32" }, "ownerTenantName": { "type": "string", "nullable": true }, "authorizedViewerTenants": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "AuthorizationDetailsUpdatePayload": { "required": [ "authorizedViewerTenantsToAdd", "authorizedViewerTenantsToRemove", "ownerTenantId", "visibleToAllTenants" ], "type": "object", "properties": { "ownerTenantId": { "type": "integer", "format": "int32" }, "authorizedViewerTenantsToAdd": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "authorizedViewerTenantsToRemove": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "AzTenantType": { "enum": [ "Partner", "Customer", "Standalone" ], "type": "string", "description": "The string or integer value may be used. Partner = 1, Customer = 2, Standalone = 3" }, "AzureError": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "oDataError": { "$ref": "#/components/schemas/ODataErrorDetails" }, "msalError": { "$ref": "#/components/schemas/MsalErrorDetails" }, "missingAccessToken": { "$ref": "#/components/schemas/MissingAccessTokenDetails" }, "apiResponseContent": { "$ref": "#/components/schemas/ApiResponseErrorContent" }, "partnerCenterApiResponseDetails": { "$ref": "#/components/schemas/ApiResponseErrorContent" }, "oauthAccessTokenErrorResponse": { "$ref": "#/components/schemas/Oauth2AccessTokenErrorResponse" }, "credentialDetails": { "$ref": "#/components/schemas/AzureTenantTokenCredentialDetails" }, "formattedErrorMessage": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AzureErrorLogItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "azureError": { "$ref": "#/components/schemas/AzureError" }, "sourceMessage": { "type": "string", "nullable": true }, "tenantPrincipalId": { "type": "string", "nullable": true }, "oauth2AccessTokenId": { "type": "integer", "format": "int32", "nullable": true }, "createdDateUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AzureGdapRelationshipDetails": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "durationNumDays": { "type": "integer", "format": "int32", "nullable": true }, "createdDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "endDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "autoExtendDuration": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/GdapRelationshipRole" }, "nullable": true }, "accessAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/GdapRelationshipAccessAssignment" }, "nullable": true } }, "additionalProperties": false }, "AzurePermissionLevel2": { "enum": [ "DefaultAppRegistration", "CustomAppRegistration" ], "type": "string", "description": "The string or integer value may be used. DefaultAppRegistration = 1, CustomAppRegistration = 3" }, "AzureSyncResult": { "type": "object", "properties": { "attemptDateUtc": { "type": "string", "format": "date-time" }, "attemptFailedErrorId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AzureTenant": { "required": [ "azureTenantType", "consentDetails", "principalId" ], "type": "object", "properties": { "principalId": { "type": "string", "nullable": true }, "consentDetails": { "$ref": "#/components/schemas/AzureTenantConsentDetails" }, "azureTenantType": { "$ref": "#/components/schemas/AzTenantType" }, "partnerPrincipalId": { "type": "string", "nullable": true }, "infoSyncedFromAzure": { "$ref": "#/components/schemas/AzureTenantInfo" }, "lastGetTenantInfoSyncResult": { "$ref": "#/components/schemas/AzureSyncResult" }, "lastGetUsersSyncResult": { "$ref": "#/components/schemas/AzureSyncResult" }, "parentPartner": { "$ref": "#/components/schemas/AzureTenant" }, "azureTenantLinks": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantLink" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AzureTenantAuthDetails": { "type": "object", "properties": { "azureTenantPrincipalId": { "type": "string", "nullable": true }, "selectedPermissionLevel": { "$ref": "#/components/schemas/AzurePermissionLevel2" }, "customAppRegAppId": { "type": "string", "nullable": true }, "customAppRegSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureTenantConsentDetails": { "type": "object", "properties": { "consentedWith": { "$ref": "#/components/schemas/AppRegistrationType" }, "consentDateUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AzureTenantCustomer": { "type": "object", "properties": { "tenantId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "gdapRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/AzureGdapRelationshipDetails" }, "nullable": true } }, "additionalProperties": false }, "AzureTenantCustomerICollectionAzureErrorOneOf": { "type": "object", "properties": { "value": { "nullable": true, "readOnly": true }, "index": { "type": "integer", "format": "int32", "readOnly": true }, "isT0": { "type": "boolean", "readOnly": true }, "isT1": { "type": "boolean", "readOnly": true }, "asT0": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantCustomer" }, "nullable": true, "readOnly": true }, "asT1": { "$ref": "#/components/schemas/AzureError" } }, "additionalProperties": false }, "AzureTenantCustomersResult": { "type": "object", "properties": { "partnerPrincipalId": { "type": "string", "nullable": true }, "result": { "$ref": "#/components/schemas/AzureTenantCustomerICollectionAzureErrorOneOf" } }, "additionalProperties": false }, "AzureTenantDetailsSyncResult": { "type": "object", "properties": { "principalId": { "type": "string", "nullable": true }, "wasSuccessful": { "type": "boolean" }, "failedReason": { "$ref": "#/components/schemas/AzureError" }, "tenantInformationSynced": { "$ref": "#/components/schemas/AzureTenantInfo" } }, "additionalProperties": false }, "AzureTenantInfo": { "required": [ "tenantName" ], "type": "object", "properties": { "tenantName": { "type": "string", "nullable": true }, "defaultDomainName": { "type": "string", "nullable": true }, "domainNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AzureTenantInfoAzureErrorOneOf": { "type": "object", "properties": { "value": { "nullable": true, "readOnly": true }, "index": { "type": "integer", "format": "int32", "readOnly": true }, "isT0": { "type": "boolean", "readOnly": true }, "isT1": { "type": "boolean", "readOnly": true }, "asT0": { "$ref": "#/components/schemas/AzureTenantInfo" }, "asT1": { "$ref": "#/components/schemas/AzureError" } }, "additionalProperties": false }, "AzureTenantLink": { "required": [ "azTenantId", "immyTenantId", "shouldLimitDomains" ], "type": "object", "properties": { "immyTenantId": { "type": "integer", "format": "int32" }, "azTenantId": { "type": "string", "nullable": true }, "shouldLimitDomains": { "type": "boolean" }, "azureTenant": { "$ref": "#/components/schemas/AzureTenant" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "limitToDomains": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantLinkDomainFilter" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AzureTenantLinkDomainFilter": { "required": [ "azTenantId", "domainName", "immyTenantId" ], "type": "object", "properties": { "immyTenantId": { "type": "integer", "format": "int32" }, "azTenantId": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureTenantLinkResponse": { "type": "object", "properties": { "immyTenantId": { "type": "integer", "format": "int32" }, "azTenantId": { "type": "string", "nullable": true }, "azureTenant": { "$ref": "#/components/schemas/AzureTenantResponse" }, "shouldLimitDomains": { "type": "boolean" }, "limitToDomains": { "type": "array", "items": { "$ref": "#/components/schemas/AzureTenantLinkDomainFilter" }, "nullable": true } }, "additionalProperties": false }, "AzureTenantResponse": { "type": "object", "properties": { "principalId": { "type": "string", "nullable": true }, "consentDetails": { "$ref": "#/components/schemas/AzureTenantConsentDetails" }, "azureTenantType": { "$ref": "#/components/schemas/AzTenantType" }, "partnerPrincipalId": { "type": "string", "nullable": true }, "infoSyncedFromAzure": { "$ref": "#/components/schemas/AzureTenantInfo" }, "lastGetUsersSyncResult": { "$ref": "#/components/schemas/AzureSyncResult" }, "lastGetTenantInfoSyncResult": { "$ref": "#/components/schemas/AzureSyncResult" } }, "additionalProperties": false }, "AzureTenantTokenCredentialDetails": { "type": "object", "properties": { "tenantPrincipalId": { "type": "string", "nullable": true }, "partnerPrincipalId": { "type": "string", "nullable": true }, "gotAccessTokenFrom": { "$ref": "#/components/schemas/AccessTokenSource" }, "resolvedClientId": { "type": "string", "nullable": true }, "onlyUsePartnerCenterRefresh": { "type": "boolean" }, "tenantPreferredAzureClientId": { "type": "string", "nullable": true }, "tenantAzurePermissionLevel": { "$ref": "#/components/schemas/AzurePermissionLevel2" } }, "additionalProperties": false }, "AzureTenantUserSyncResult": { "type": "object", "properties": { "principalId": { "type": "string", "nullable": true }, "wasSuccessful": { "type": "boolean" }, "failedReason": { "$ref": "#/components/schemas/AzureError" }, "numUsersSynced": { "type": "integer", "format": "int32" }, "immyTenantsSyncedUsers": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "BatchSetExcludedFromUserAffinityRequestBody": { "type": "object", "properties": { "computerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isExcluded": { "type": "boolean" } }, "additionalProperties": false }, "BatchUpdateAssignmentRequest": { "type": "object", "properties": { "targetAssignmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "updateArray": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateTargetVisibilityPayload" }, "nullable": true } }, "additionalProperties": false }, "BeginAuthCodeFlowRequest": { "type": "object", "properties": { "oauthConsentData": { "$ref": "#/components/schemas/OauthConsentData" }, "allowSilentRefresh": { "type": "boolean" } }, "additionalProperties": false }, "BeginAuthCodeFlowResponse": { "type": "object", "properties": { "oauthHookId": { "type": "string", "format": "uuid" }, "pkceCodeChallenge": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingPlatformDetails": { "type": "object", "properties": { "siteName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Branding": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "ignoreYear": { "type": "boolean", "nullable": true }, "timeFormat": { "type": "string", "nullable": true }, "mascotImgUri": { "type": "string", "nullable": true }, "mascotName": { "type": "string", "nullable": true }, "logoUri": { "type": "string", "nullable": true }, "logoAltText": { "type": "string", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "foregroundColor": { "type": "string", "nullable": true }, "tableHeaderColor": { "type": "string", "nullable": true }, "tableHeaderTextColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "BulkCreateTenantRequestBody": { "type": "object", "properties": { "ownerTenantId": { "type": "integer", "format": "int32" }, "tenants": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCreateTenantRequestBodyListItem" }, "nullable": true } }, "additionalProperties": false }, "BulkCreateTenantRequestBodyListItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "principalId": { "type": "string", "nullable": true }, "partnerPrincipalId": { "type": "string", "nullable": true }, "limitToDomains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkDeleteRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "permanent": { "type": "boolean" }, "deleteOwnedEntities": { "type": "boolean" }, "newOwnerTenantId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BulkDeleteResponse": { "type": "object", "properties": { "numDeleted": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BulkLinkClientsToTenantsRequestBody": { "type": "object", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BulkOperationResponse": { "type": "object", "properties": { "recordCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BulkScheduleOperationResult": { "type": "object", "properties": { "scheduleId": { "type": "integer", "description": "The schedule identifier this result pertains to.", "format": "int32" }, "success": { "type": "boolean", "description": "Indicates whether the operation succeeded for this schedule." }, "errorMessage": { "type": "string", "description": "Optional error message when Immybot.Backend.Web.Common.Contracts.V1.Responses.BulkScheduleOperationResult.Success is false; otherwise null.\r\nContains a generic message and never includes sensitive details.", "nullable": true } }, "additionalProperties": false, "description": "Result for a single schedule item in a bulk operation." }, "BulkScheduleRequest": { "type": "object", "properties": { "scheduleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "BulkScheduleStatusRequest": { "type": "object", "properties": { "scheduleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "disabled": { "type": "boolean" } }, "additionalProperties": false }, "CalculateTargetedComputer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "cn": { "type": "string", "nullable": true }, "on": { "type": "boolean" }, "tn": { "type": "string", "nullable": true }, "ppi": { "type": "integer", "format": "int32", "nullable": true }, "ppn": { "type": "string", "nullable": true }, "ti": { "type": "integer", "format": "int32" }, "os": { "type": "string", "nullable": true }, "obs": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "sn": { "type": "string", "nullable": true }, "dr": { "type": "integer", "format": "int32", "nullable": true }, "sb": { "type": "boolean" }, "ct": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CalculateTargetedComputerResponse": { "type": "object", "properties": { "targetedComputers": { "type": "array", "items": { "$ref": "#/components/schemas/CalculateTargetedComputer" }, "nullable": true }, "hasUnauthorizedComputers": { "type": "boolean" } }, "additionalProperties": false }, "CalculateTargetsRequest": { "type": "object", "properties": { "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "onboardingOnly": { "type": "boolean" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" } }, "additionalProperties": false }, "CallingConventions": { "enum": [ "Standard", "VarArgs", "Any", "HasThis", "ExplicitThis" ], "type": "string", "description": "The string or integer value may be used. Standard = 1, VarArgs = 2, Any = 3, HasThis = 32, ExplicitThis = 64" }, "CancelApplicationLockRequest": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "cancelReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CancelSessionsRequestBody": { "type": "object", "properties": { "sessionIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CategoryResourceAssignmentDto": { "required": [ "resourceCategory", "resourceType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "resourceType": { "type": "string", "nullable": true }, "resourceCategory": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeRequest": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "objectType": { "$ref": "#/components/schemas/ChangeRequestObjectType" }, "targetAssignmentId": { "type": "integer", "format": "int32", "nullable": true }, "scriptId": { "type": "integer", "format": "int32", "nullable": true }, "newValuesJson": { }, "state": { "$ref": "#/components/schemas/ChangeRequestState" }, "acknowledgedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "acknowledgedByUserName": { "type": "string", "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestComment" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "targetAssignment": { "$ref": "#/components/schemas/TargetAssignment" }, "script": { "$ref": "#/components/schemas/Script" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "tenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ChangeRequestComment": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "nullable": true }, "commentedByUsername": { "type": "string", "nullable": true }, "changeRequestId": { "type": "integer", "format": "int32" }, "changeRequest": { "$ref": "#/components/schemas/ChangeRequest" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "ChangeRequestCommentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "nullable": true }, "commentedByUsername": { "type": "string", "nullable": true }, "changeRequestId": { "type": "integer", "format": "int32" }, "createdDateUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ChangeRequestDiff": { "type": "object", "properties": { "oldDeploymentDescription": { "type": "string", "nullable": true }, "newDeploymentDescription": { "type": "string", "nullable": true }, "parameterDiffs": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestParameterDiff" }, "nullable": true } }, "additionalProperties": false }, "ChangeRequestObjectType": { "enum": [ "TargetAssignment", "Script" ], "type": "string", "description": "The string or integer value may be used. TargetAssignment = 1, Script = 2" }, "ChangeRequestParameterDiff": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "oldValue": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "newValue": { "$ref": "#/components/schemas/DeploymentParameterValue" } }, "additionalProperties": false }, "ChangeRequestResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "objectType": { "$ref": "#/components/schemas/ChangeRequestObjectType" }, "targetAssignmentId": { "type": "integer", "format": "int32", "nullable": true }, "scriptId": { "type": "integer", "format": "int32", "nullable": true }, "newValuesJson": { }, "state": { "$ref": "#/components/schemas/ChangeRequestState" }, "acknowledgedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "acknowledgedByUserName": { "type": "string", "nullable": true }, "createdDateUtc": { "type": "string", "format": "date-time" }, "createdByUserName": { "type": "string", "nullable": true }, "createdByUserId": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUtc": { "type": "string", "format": "date-time" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestCommentResponse" }, "nullable": true } }, "additionalProperties": false }, "ChangeRequestState": { "enum": [ "WaitingForApproval", "Denied", "ApprovedAndApplied", "NeedsAttention" ], "type": "string", "description": "The string or integer value may be used. WaitingForApproval = 1, Denied = 2, ApprovedAndApplied = 3, NeedsAttention = 4" }, "ChangeTenantsPayload": { "type": "object", "properties": { "targetTenantId": { "type": "integer", "format": "int32" }, "computersToMove": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CheckTenantPartnerStatusResponseBody": { "type": "object", "properties": { "tenantPrincipalId": { "type": "string", "nullable": true }, "partnerPrincipalId": { "type": "string", "nullable": true }, "azureTenantType": { "$ref": "#/components/schemas/AzTenantType" } }, "additionalProperties": false }, "ChocoPackageVersion": { "required": [ "id", "title", "version" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/NuGetVersion" } }, "additionalProperties": false }, "ChocoSearchResult": { "required": [ "id", "title" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CircuitBreakerState": { "type": "object", "properties": { "policyName": { "type": "string", "nullable": true }, "circuitState": { "type": "string", "nullable": true }, "lastException": { "$ref": "#/components/schemas/Exception" } }, "additionalProperties": false }, "ClaimResponse": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the claim", "nullable": true }, "value": { "type": "string", "description": "The value of the claim", "nullable": true } }, "additionalProperties": false, "description": "Represents a single claim with type and value" }, "ClearApplicationLogSourceContextRequest": { "type": "object", "properties": { "sourceContext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientGroupTypeDto": { "type": "object", "properties": { "clientGroupTypeId": { "type": "string", "format": "uuid" }, "providerTypeId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloneRoleRequest": { "required": [ "newName" ], "type": "object", "properties": { "newName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommandResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommandTypes": { "enum": [ "Alias", "Function", "Filter", "Cmdlet", "ExternalScript", "Application", "Script", "Configuration", "All" ], "type": "string", "description": "The string or integer value may be used. Alias = 1, Function = 2, Filter = 4, Cmdlet = 8, ExternalScript = 16, Application = 32, Script = 64, Configuration = 256, All = 383" }, "Computer": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "deviceId": { "type": "string", "format": "uuid" }, "tenantId": { "type": "integer", "format": "int32" }, "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true }, "onboardingStatus": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "onboardedDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "inventoryStartedDate": { "type": "string", "format": "date-time", "nullable": true }, "detectionOutdated": { "type": "boolean" }, "computerName": { "type": "string", "nullable": true }, "chassisTypes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "operatingSystem": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "domainRole": { "type": "integer", "format": "int32", "nullable": true }, "hasPendingReboot": { "type": "boolean", "nullable": true }, "domain": { "type": "string", "nullable": true }, "lastBootTimeUtc": { "type": "string", "nullable": true }, "internalIpAddress": { "type": "string", "nullable": true }, "externalIpAddress": { "type": "string", "nullable": true }, "lastLoggedOnUser": { "type": "string", "nullable": true }, "osInstallDate": { "type": "string", "format": "date-time", "nullable": true }, "isSandbox": { "type": "boolean" }, "excludedFromUserAffinity": { "type": "boolean" }, "devLabVmClaimExpirationDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "devLabVmUnclaimed": { "type": "boolean" }, "devLabVmName": { "type": "string", "nullable": true }, "excludeFromMaintenance": { "type": "boolean" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "primaryPerson": { "$ref": "#/components/schemas/Person" }, "latestProviderEvent": { "$ref": "#/components/schemas/ComputerLatestProviderEvent" }, "computerNote": { "$ref": "#/components/schemas/ComputerNote" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceSession" }, "nullable": true }, "additionalPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerPerson" }, "nullable": true }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" }, "nullable": true }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderAgent" }, "nullable": true }, "latestInventoryScriptResults": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventoryTaskScriptResult" }, "nullable": true }, "agentIdentificationFailures": { "type": "array", "items": { "$ref": "#/components/schemas/AgentIdentificationFailure" }, "nullable": true }, "detectedSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftware" }, "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true }, "remoteControlRecordings": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteControlRecording" }, "nullable": true }, "userAffinities": { "type": "array", "items": { "$ref": "#/components/schemas/UserAffinity" }, "nullable": true }, "computerTags": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerTag" }, "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedReason": { "type": "string", "nullable": true }, "successorComputerId": { "type": "integer", "format": "int32", "nullable": true }, "successorComputer": { "$ref": "#/components/schemas/Computer" }, "predecessorComputers": { "type": "array", "items": { "$ref": "#/components/schemas/Computer" }, "nullable": true } }, "additionalProperties": false }, "ComputerAgentStatusDto": { "required": [ "agents", "allAgentsConnected", "computerName", "id", "someConnected", "tenantId", "tenantName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "allAgentsConnected": { "type": "boolean" }, "someConnected": { "type": "boolean" }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/AgentStatusDto" }, "nullable": true } }, "additionalProperties": false }, "ComputerDto": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInDeploymentDto" }, "nullable": true } }, "additionalProperties": false }, "ComputerInDeploymentDto": { "type": "object", "properties": { "deploymentId": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "ComputerInventorySoftware": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true }, "upgradeCode": { "type": "string", "format": "uuid", "nullable": true }, "computers": { "type": "integer", "format": "int32" }, "capturedDisplayVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComputerInventoryTaskScriptResult": { "required": [ "inventoryKey" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "computerId": { "type": "integer", "format": "int32" }, "inventoryKey": { "type": "string", "nullable": true }, "latestSuccessResult": { "nullable": true }, "latestErrorResult": { "nullable": true }, "latestResultIsError": { "type": "boolean" }, "computer": { "$ref": "#/components/schemas/Computer" } }, "additionalProperties": false }, "ComputerLatestProviderEvent": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "lastProviderAgentEventDateUtc": { "type": "string", "format": "date-time" }, "computer": { "$ref": "#/components/schemas/Computer" } }, "additionalProperties": false }, "ComputerListViewModel": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "isOnline": { "type": "boolean", "nullable": true }, "primaryUserFirstName": { "type": "string", "nullable": true }, "primaryUserLastName": { "type": "string", "nullable": true }, "primaryUserEmail": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true }, "providerLinkIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "computerTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "deviceId": { "type": "string", "format": "uuid" }, "onboardingStatus": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "activeSessionStatus": { "$ref": "#/components/schemas/SessionStatus" }, "activeSessionId": { "type": "integer", "format": "int32", "nullable": true }, "computerName": { "type": "string", "nullable": true }, "chassisTypes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "operatingSystem": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "domainRole": { "type": "integer", "format": "int32", "nullable": true }, "hasPendingReboot": { "type": "boolean", "nullable": true }, "domain": { "type": "string", "nullable": true }, "lastBootTimeUtc": { "type": "string", "nullable": true }, "internalIpAddress": { "type": "string", "nullable": true }, "externalIpAddress": { "type": "string", "nullable": true }, "lastLoggedOnUser": { "type": "string", "nullable": true }, "isSandbox": { "type": "boolean" }, "excludeFromMaintenance": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "devLabVmClaimExpirationDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "devLabVmUnclaimed": { "type": "boolean" }, "devLabVmName": { "type": "string", "nullable": true }, "isDevLab": { "type": "boolean", "readOnly": true }, "lastProviderAgentEventDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "licensed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ComputerNameResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComputerNote": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32" }, "content": { "type": "string", "nullable": true }, "computer": { "$ref": "#/components/schemas/Computer" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "ComputerOfflineMaintenanceSessionBehavior": { "enum": [ "Skip", "ApplyOnConnect" ], "type": "string", "description": "The string or integer value may be used. Skip = 1, ApplyOnConnect = 2" }, "ComputerOnboardingStatus": { "enum": [ "NeedsOnboarding", "Onboarding", "Onboarded" ], "type": "string", "description": "The string or integer value may be used. NeedsOnboarding = 0, Onboarding = 1, Onboarded = 2" }, "ComputerPageResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerListViewModel" }, "nullable": true } }, "additionalProperties": false }, "ComputerPerson": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "personId": { "type": "integer", "format": "int32" }, "computer": { "$ref": "#/components/schemas/Computer" }, "person": { "$ref": "#/components/schemas/Person" } }, "additionalProperties": false }, "ComputerSearch": { "required": [ "name", "tenant" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "tenant": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "online": { "type": "boolean" }, "updatedDate": { "type": "string", "format": "date-time" }, "excludeFromMaintenance": { "type": "boolean" } }, "additionalProperties": false }, "ComputerTag": { "type": "object", "properties": { "entityId": { "type": "integer", "format": "int32" }, "tagId": { "type": "integer", "format": "int32" }, "computer": { "$ref": "#/components/schemas/Computer" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "additionalProperties": false }, "ComputerUserAffinityResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "personId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "personName": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Condition": { "enum": [ "Installed", "NotInstalled" ], "type": "string", "description": "The string or integer value may be used. Installed = 0, NotInstalled = 1" }, "ConstructorInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" } }, "additionalProperties": false }, "ContributingRoleAssignment": { "required": [ "assignment" ], "type": "object", "properties": { "roleName": { "type": "string", "nullable": true }, "isBuiltIn": { "type": "boolean" }, "assignment": { "$ref": "#/components/schemas/UserRoleAssignmentDto" }, "assignmentScopeDescription": { "type": "string", "nullable": true }, "precedenceLevel": { "type": "integer", "format": "int32" }, "isWinning": { "type": "boolean" }, "overrideReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateBrandingRequestBody": { "required": [ "description" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "ignoreYear": { "type": "boolean", "nullable": true }, "timeFormat": { "type": "string", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "mascotImgUri": { "type": "string", "nullable": true }, "mascotName": { "type": "string", "nullable": true }, "logoUri": { "type": "string", "nullable": true }, "logoAltText": { "type": "string", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "foregroundColor": { "type": "string", "nullable": true }, "tableHeaderColor": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tableHeaderTextColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCategoryResourceAssignmentRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResourceAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateDynamicIntegrationTypePayload": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "scriptId": { "type": "integer", "format": "int32" }, "logoId": { "type": "integer", "format": "int32" }, "docsUrl": { "type": "string", "nullable": true }, "tag": { "$ref": "#/components/schemas/IntegrationTag" }, "integrationTypeId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateGlobalMaintenanceTaskPayload": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "onboardingOnly": { "type": "boolean" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "recommended": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterPayload" }, "nullable": true, "readOnly": true }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "executeSerially": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "useScriptParamBlock": { "type": "boolean" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CreateGlobalScriptRequestBody": { "required": [ "action", "name" ], "type": "object", "properties": { "action": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" } }, "additionalProperties": false }, "CreateGlobalSoftwareRequestBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "licenseDescription": { "type": "string", "nullable": true }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairType": { "type": "integer", "format": "int32", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "upgradeCode": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true } }, "additionalProperties": false }, "CreateGlobalSoftwareVersionRequestBody": { "required": [ "semanticVersion" ], "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "blobName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareId": { "type": "integer", "format": "int32" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CreateGlobalTargetAssignmentPayload": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "excluded": { "type": "boolean" }, "onboardingOnly": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" } }, "additionalProperties": false }, "CreateGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateLicenseRequestBody": { "required": [ "licenseValue", "name", "softwareIdentifier" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "licenseValue": { "type": "string", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true }, "softwareName": { "type": "string", "description": "Set in controller, not by the frontend", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "restrictToMajorVersion": { "type": "boolean" } }, "additionalProperties": false }, "CreateLinkedProviderReferenceRequestBody": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "isCrossProviderClientExternalLinkingEnabled": { "type": "boolean" } }, "additionalProperties": false }, "CreateLocalMaintenanceTaskPayload": { "required": [ "name" ], "type": "object", "properties": { "authorizedViewerTenantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "tenantId": { "type": "integer", "format": "int32" }, "visibleToAllTenants": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "onboardingOnly": { "type": "boolean" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "recommended": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterPayload" }, "nullable": true, "readOnly": true }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "executeSerially": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "useScriptParamBlock": { "type": "boolean" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateLocalScriptRequestBody": { "required": [ "action", "name" ], "type": "object", "properties": { "action": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "ownerTenantId": { "type": "integer", "format": "int32" }, "authorizedViewerTenants": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "CreateLocalSoftwareRequestBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "licenseDescription": { "type": "string", "nullable": true }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairType": { "type": "integer", "format": "int32", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "upgradeCode": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "ownerTenantId": { "type": "integer", "format": "int32" }, "authorizedViewerTenants": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "CreateLocalSoftwareVersionRequestBody": { "required": [ "semanticVersion" ], "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "blobName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareId": { "type": "integer", "format": "int32" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "CreateLocalTargetAssignmentPayload": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "excluded": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "onboardingOnly": { "type": "boolean" }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetVisibility": { "$ref": "#/components/schemas/TargetAssignmentVisibilityPayload" } }, "additionalProperties": false }, "CreateMspAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/MspAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateOrUpdateRoleRequest": { "required": [ "description", "grantedPermissionIds", "name", "ownerTenantId" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "grantedPermissionIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateOwnerAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreatePersonPayload": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "azurePrincipalId": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "onPremisesSecurityIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateProviderLinkRequestBody": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "providerTypeId": { "type": "string", "format": "uuid" }, "providerTypeFormData": { "description": "Used by the manager to create immy agent links", "nullable": true } }, "additionalProperties": false }, "CreateProviderLinkWithExternalProviderReferenceRequestBody": { "required": [ "providerLink" ], "type": "object", "properties": { "providerLink": { "$ref": "#/components/schemas/ProviderLink" }, "providerLinkExternalReferenceData": { "$ref": "#/components/schemas/ProviderLinkExternalReferenceDataBody" } }, "additionalProperties": false }, "CreateScheduleRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "customCronExpression": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "day": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTime": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" }, "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "applyWindowsUpdates": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" }, "allowAccessToMSPResources": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" } }, "additionalProperties": false }, "CreateSmtpRequest": { "required": [ "host", "password" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "host": { "type": "string", "nullable": true }, "enableSSL": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "CreateSpecificResourceAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificResourceAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateSpecificTenantAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificTenantAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateTagPayload": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32" }, "authorizedViewerTenants": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "CreateTagResourceAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/TagResourceAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateTargetAssignmentChangeRequestRequest": { "required": [ "payload" ], "type": "object", "properties": { "ownerTenantId": { "type": "integer", "format": "int32" }, "payload": { "$ref": "#/components/schemas/CreateLocalTargetAssignmentPayload" } }, "additionalProperties": false }, "CreateTenantRequestBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32" }, "principalId": { "type": "string", "nullable": true }, "partnerPrincipalId": { "type": "string", "nullable": true }, "limitToDomains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "slug": { "type": "string", "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32", "nullable": true }, "isMsp": { "type": "boolean" } }, "additionalProperties": false }, "CreateTenantTagAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/TenantTagAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateUserFromPersonRequest": { "type": "object", "properties": { "personIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "expirationTime": { "$ref": "#/components/schemas/ExpirationTime" } }, "additionalProperties": false }, "CreateUserTenantAssignmentsRequest": { "required": [ "dtos" ], "type": "object", "properties": { "dtos": { "type": "array", "items": { "$ref": "#/components/schemas/UserTenantAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateUsersFromPersonIdsResponse": { "type": "object", "properties": { "createdUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "$ref": "#/components/schemas/Type" }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "$ref": "#/components/schemas/Type" }, "value": { "nullable": true } }, "additionalProperties": false }, "CustomerPortalSessionStatus": { "enum": [ "UnKnown", "Created", "LoggedIn", "LoggedOut", "NotYetActivated", "Activated" ], "type": "string", "description": "The string or integer value may be used. UnKnown = 0, Created = 1, LoggedIn = 2, LoggedOut = 3, NotYetActivated = 4, Activated = 5" }, "DataSourceLoadOptions": { "type": "object", "properties": { "requireTotalCount": { "type": "boolean" }, "requireGroupCount": { "type": "boolean" }, "isCountQuery": { "type": "boolean" }, "isSummaryQuery": { "type": "boolean" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortingInfo" }, "nullable": true }, "group": { "type": "array", "items": { "$ref": "#/components/schemas/GroupingInfo" }, "nullable": true }, "filter": { "type": "array", "items": { }, "nullable": true }, "totalSummary": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" }, "nullable": true }, "groupSummary": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryInfo" }, "nullable": true }, "select": { "type": "array", "items": { "type": "string" }, "nullable": true }, "preSelect": { "type": "array", "items": { "type": "string" }, "nullable": true }, "remoteSelect": { "type": "boolean", "nullable": true }, "remoteGrouping": { "type": "boolean", "nullable": true }, "expandLinqSumType": { "type": "boolean", "nullable": true }, "primaryKey": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultSort": { "type": "string", "nullable": true }, "stringToLower": { "type": "boolean", "nullable": true }, "paginateViaPrimaryKey": { "type": "boolean", "nullable": true }, "sortByPrimaryKey": { "type": "boolean", "nullable": true }, "allowAsyncOverSync": { "type": "boolean" } }, "additionalProperties": false }, "DatabaseType": { "enum": [ "Global", "Local" ], "type": "string", "description": "The string or integer value may be used. Global = 0, Local = 1" }, "DefaultEmailBccList": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DefaultScriptTimeouts": { "type": "object", "properties": { "detection": { "type": "integer", "format": "int32" }, "action": { "type": "integer", "format": "int32" }, "install": { "type": "integer", "format": "int32" }, "uninstall": { "type": "integer", "format": "int32" }, "upgrade": { "type": "integer", "format": "int32" }, "autoUpdateJob": { "type": "integer", "format": "int32", "deprecated": true }, "dynamicVersions": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeleteAzureTenantAuthDetailsCmdPayload": { "type": "object", "properties": { "azureTenantPrincipalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteAzureTenantAuthDetailsCmdResult": { "type": "object", "properties": { "defaultAppRegistrationUpdated": { "type": "boolean" } }, "additionalProperties": false }, "DeleteTenantResult": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "success": { "type": "boolean" }, "failedReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteTenantsCmdResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "tenantResults": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteTenantResult" }, "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeletionStatus": { "enum": [ "Pending", "InProgress", "Completed", "Errored" ], "type": "string", "description": "The string or integer value may be used. Pending = 0, InProgress = 1, Completed = 2, Errored = 3" }, "DeploymentParameterValue": { "type": "object", "properties": { "value": { "nullable": true }, "allowOverride": { "type": "boolean", "nullable": true }, "requiresOverride": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DesiredSoftwareState": { "enum": [ "NewerOrEqualVersion", "NotPresent", "AnyVersion", "ThisVersion", "OlderOrEqualVersion", "LatestVersion", "NoAction", "UpdateIfFound" ], "type": "string", "description": "The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7" }, "DetectedComputerSoftware": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "context": { "$ref": "#/components/schemas/SoftwareRegistryContext" }, "displayIcon": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true }, "globalSoftwareId": { "type": "integer", "format": "int32", "nullable": true }, "globalSoftwareName": { "type": "string", "nullable": true }, "installDate": { "type": "string", "format": "date-time", "nullable": true }, "platform": { "type": "string", "nullable": true }, "productCode": { "type": "string", "format": "uuid", "nullable": true }, "quietUninstallString": { "type": "string", "nullable": true }, "systemComponent": { "type": "integer", "format": "int32", "nullable": true }, "uninstallString": { "type": "string", "nullable": true }, "upgradeCode": { "type": "string", "format": "uuid", "nullable": true }, "userName": { "type": "string", "nullable": true }, "userSid": { "type": "string", "nullable": true }, "detectedAt": { "type": "string", "format": "date-time" }, "computer": { "$ref": "#/components/schemas/Computer" }, "computerId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "tenantId": { "type": "integer", "format": "int32" }, "primaryPerson": { "$ref": "#/components/schemas/Person" }, "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true }, "registryPath": { "type": "string", "nullable": true }, "installLocation": { "type": "string", "nullable": true }, "originalKey": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DetectedComputerSoftwareResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32" }, "softwareName": { "type": "string", "nullable": true }, "softwareId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "personName": { "type": "string", "nullable": true }, "personEmail": { "type": "string", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "version": { "type": "string", "nullable": true }, "detectedAt": { "type": "string", "format": "date-time" }, "installDate": { "type": "string", "format": "date-time", "nullable": true }, "platform": { "type": "string", "nullable": true }, "productCode": { "type": "string", "format": "uuid", "nullable": true }, "upgradeCode": { "type": "string", "format": "uuid", "nullable": true }, "quietUninstallString": { "type": "string", "nullable": true }, "uninstallString": { "type": "string", "nullable": true }, "systemComponent": { "type": "integer", "format": "int32", "nullable": true }, "registryPath": { "type": "string", "nullable": true }, "installLocation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DetectionMethod": { "enum": [ "SoftwareTable", "CustomDetectionScript", "UpgradeCode", "ProductCode" ], "type": "string", "description": "The string or integer value may be used. SoftwareTable = 0, CustomDetectionScript = 1, UpgradeCode = 2, ProductCode = 3" }, "DevInstanceDetails": { "required": [ "backendVersion" ], "type": "object", "properties": { "backendVersion": { "type": "string", "nullable": true }, "isHangfireServerRunning": { "type": "boolean" }, "postRoutes": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DeviceDetails": { "type": "object", "properties": { "operatingSystemName": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "deviceName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "nullable": true }, "osInstallDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "machineId": { "type": "string", "nullable": true }, "isSandbox": { "type": "boolean" }, "domain": { "type": "string", "nullable": true }, "azureTenantId": { "type": "string", "nullable": true }, "domainRole": { "type": "integer", "format": "int32", "nullable": true }, "chassisTypes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DeviceGroupTypeDto": { "type": "object", "properties": { "deviceGroupTypeId": { "type": "string", "format": "uuid" }, "providerTypeId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "targetScope": { "$ref": "#/components/schemas/TargetScope" } }, "additionalProperties": false }, "DeviceUpdateFormDataResponse": { "type": "object", "properties": { "agentId": { "type": "integer", "format": "int32" }, "deviceUpdateFormData": { "nullable": true } }, "additionalProperties": false }, "DisabledPreflightScriptResponse": { "required": [ "databaseType", "id", "scriptId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scriptId": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "DisambiguateAzureTenantTypeRequestBody": { "type": "object", "properties": { "tenantPrincipalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DoesScriptHaveParamBlockRequest": { "type": "object", "properties": { "script": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DuplicateAssignmentRequestBody": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "DuplicateMaintenanceTaskRequestbody": { "type": "object", "properties": { "maintenanceTaskId": { "type": "integer", "format": "int32" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "DuplicateScriptRequestBody": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "DuplicateTargetAssignmentPayload": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "target": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "onboardingOnly": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "excluded": { "type": "boolean" } }, "additionalProperties": false }, "DxComputerInventoryScriptResult": { "required": [ "computerId", "computerName", "inventoryKey", "success", "tenantId", "tenantName", "timestampUtc" ], "type": "object", "properties": { "computerName": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "timestampUtc": { "type": "string", "format": "date-time" }, "success": { "type": "boolean" }, "inventoryKey": { "type": "string", "nullable": true }, "latestSuccessResult": { "nullable": true }, "latestSuccessResultJson": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DxRoleAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true }, "assignmentTypeName": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "claimValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DynamicFormBindResult": { "type": "object", "properties": { "bindErrors": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "showCommandInfo": { "$ref": "#/components/schemas/ShowCommandInfo" }, "parameterSetName": { "type": "string", "nullable": true }, "hasErrors": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DynamicFormBindResultOpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/DynamicFormBindResult" } }, "additionalProperties": false }, "DynamicFormBindResultWithConvertedParameters": { "type": "object", "properties": { "bindErrors": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "showCommandInfo": { "$ref": "#/components/schemas/ShowCommandInfo" }, "parameterSetName": { "type": "string", "nullable": true }, "hasErrors": { "type": "boolean", "readOnly": true }, "convertedParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "DynamicIntegrationType": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "logoId": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "scriptId": { "type": "integer", "format": "int32" }, "script": { "$ref": "#/components/schemas/Script" }, "creationErrorMessage": { "type": "string", "nullable": true }, "docsUrl": { "type": "string", "nullable": true }, "tag": { "$ref": "#/components/schemas/IntegrationTag" }, "logo": { "$ref": "#/components/schemas/Media" }, "secrets": { "nullable": true } }, "additionalProperties": false }, "DynamicIntegrationTypeProperties": { "type": "object", "properties": { "providerTypeId": { "type": "string", "format": "uuid" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true }, "logoMediaId": { "type": "integer", "format": "int32" }, "secrets": { "type": "object", "additionalProperties": { }, "nullable": true }, "docsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicIntegrationTypeResponse": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "scriptId": { "type": "integer", "format": "int32" }, "createdDateUtc": { "type": "string", "format": "date-time" }, "updatedDateUtc": { "type": "string", "format": "date-time" }, "creationErrorMessage": { "type": "string", "nullable": true }, "docsUrl": { "type": "string", "nullable": true }, "logoId": { "type": "integer", "format": "int32" }, "logo": { "$ref": "#/components/schemas/GlobalMediaResponse" }, "tag": { "$ref": "#/components/schemas/IntegrationTag" } }, "additionalProperties": false }, "EnqueuedSessionType": { "enum": [ "HangfireAdhoc", "HangfireOnboarding", "HangfireScheduled", "HangfireConnectivityTriggered", "NotHangfire" ], "type": "string", "description": "The string or integer value may be used. HangfireAdhoc = 1, HangfireOnboarding = 2, HangfireScheduled = 3, HangfireConnectivityTriggered = 4, NotHangfire = 5" }, "EvaluateAllAssignmentsRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EvaluateAllAssignmentsResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAssignmentOverview" }, "nullable": true } }, "additionalProperties": false }, "EvaluateResourcePermissionsRequest": { "required": [ "resourceId", "resourceType" ], "type": "object", "properties": { "resourceType": { "type": "string", "nullable": true }, "resourceId": { "type": "integer", "format": "int32" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EvaluateResourcePermissionsResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true }, "resourceId": { "type": "integer", "format": "int32" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionEvaluationResult" }, "nullable": true }, "allowedCount": { "type": "integer", "format": "int32" }, "deniedCount": { "type": "integer", "format": "int32" }, "notGrantedCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EvaluateTenantPermissionsRequest": { "required": [ "tenantId" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EvaluateTenantPermissionsResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionEvaluationResult" }, "nullable": true }, "allowedCount": { "type": "integer", "format": "int32" }, "deniedCount": { "type": "integer", "format": "int32" }, "notGrantedCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EventAttributes": { "enum": [ "None", "SpecialName", "RTSpecialName", "ReservedMask" ], "type": "string", "description": "The string or integer value may be used. None = 0, SpecialName = 512, RTSpecialName = 1024, ReservedMask = 1024" }, "EventInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/EventAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "addMethod": { "$ref": "#/components/schemas/MethodInfo" }, "removeMethod": { "$ref": "#/components/schemas/MethodInfo" }, "raiseMethod": { "$ref": "#/components/schemas/MethodInfo" }, "isMulticast": { "type": "boolean", "readOnly": true }, "eventHandlerType": { "$ref": "#/components/schemas/Type" } }, "additionalProperties": false }, "Exception": { "type": "object", "properties": { "targetSite": { "$ref": "#/components/schemas/MethodBase" }, "message": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ExcludeFromMaintenanceRequest": { "type": "object", "properties": { "exclude": { "type": "boolean" } }, "additionalProperties": false }, "ExpirationTime": { "enum": [ "OneHour", "OneDay", "Indefinite", "ThreeDays" ], "type": "string", "description": "The string or integer value may be used. OneHour = 1, OneDay = 2, Indefinite = 3, ThreeDays = 4" }, "ExternalAgentId": { "type": "object", "properties": { "value": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FailAuthCodeFlowRequest": { "type": "object", "properties": { "oauthHookId": { "type": "string", "format": "uuid" }, "oauthErrorResponse": { "$ref": "#/components/schemas/Oauth2AuthCodeErrorResponse" } }, "additionalProperties": false }, "FastCreateGlobalVersionRequestBody": { "type": "object", "properties": { "softwareId": { "type": "integer", "format": "int32", "nullable": true }, "software": { "$ref": "#/components/schemas/CreateGlobalSoftwareRequestBody" }, "softwareVersion": { "$ref": "#/components/schemas/CreateGlobalSoftwareVersionRequestBody" } }, "additionalProperties": false }, "FastCreateLocalVersionRequestBody": { "type": "object", "properties": { "softwareId": { "type": "integer", "format": "int32", "nullable": true }, "software": { "$ref": "#/components/schemas/CreateLocalSoftwareRequestBody" }, "softwareVersion": { "$ref": "#/components/schemas/CreateLocalSoftwareVersionRequestBody" } }, "additionalProperties": false }, "Feature": { "required": [ "enabled", "name" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FeatureEnabledFromSubscription": { "type": "object", "properties": { "featureId": { "type": "string", "nullable": true }, "featureEntitlementType": { "$ref": "#/components/schemas/FeatureEntitlementType" }, "isUsageBased": { "type": "boolean" }, "featureUsage": { "$ref": "#/components/schemas/FeatureUsageDetails" }, "featureCustomValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FeatureEntitlementType": { "enum": [ "Switch", "Quantity", "Range", "Custom" ], "type": "string", "description": "The string or integer value may be used. Switch = 1, Quantity = 2, Range = 3, Custom = 4" }, "FeatureResetInterval": { "enum": [ "Daily", "Monthly" ], "type": "string", "description": "The string or integer value may be used. Daily = 0, Monthly = 1" }, "FeatureUsageDetails": { "type": "object", "properties": { "maxCount": { "type": "integer", "format": "int32", "nullable": true }, "maxCountPerItem": { "type": "integer", "format": "int32", "nullable": true }, "resetInterval": { "$ref": "#/components/schemas/FeatureResetInterval" }, "featureTrackStartDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "itemCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FieldAttributes": { "enum": [ "PrivateScope", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "FieldAccessMask", "Static", "InitOnly", "Literal", "NotSerialized", "HasFieldRVA", "SpecialName", "RTSpecialName", "HasFieldMarshal", "PinvokeImpl", "HasDefault", "ReservedMask" ], "type": "string", "description": "The string or integer value may be used. PrivateScope = 0, Private = 1, FamANDAssem = 2, Assembly = 3, Family = 4, FamORAssem = 5, Public = 6, FieldAccessMask = 7, Static = 16, InitOnly = 32, Literal = 64, NotSerialized = 128, HasFieldRVA = 256, SpecialName = 512, RTSpecialName = 1024, HasFieldMarshal = 4096, PinvokeImpl = 8192, HasDefault = 32768, ReservedMask = 38144" }, "FieldInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/FieldAttributes" }, "fieldType": { "$ref": "#/components/schemas/Type" }, "isInitOnly": { "type": "boolean", "readOnly": true }, "isLiteral": { "type": "boolean", "readOnly": true }, "isNotSerialized": { "type": "boolean", "readOnly": true, "deprecated": true }, "isPinvokeImpl": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "fieldHandle": { "$ref": "#/components/schemas/RuntimeFieldHandle" } }, "additionalProperties": false }, "FilterScriptMode": { "enum": [ "Legacy", "Optimized" ], "type": "string", "description": "The string or integer value may be used. Legacy = 0, Optimized = 1" }, "FinishAuthCodeFlowRequest": { "type": "object", "properties": { "oauthHookId": { "type": "string", "format": "uuid" }, "authCode": { "type": "string", "nullable": true }, "redirectUriUsedInAuthLeg": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "GdapRelationshipAccessAssignment": { "type": "object", "properties": { "accessContainerId": { "type": "string", "nullable": true }, "accessContainerType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GdapRelationshipRole": { "type": "object", "properties": { "roleDefinitionId": { "type": "string", "nullable": true }, "roleDefinitionName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GenericParameterAttributes": { "enum": [ "None", "Covariant", "Contravariant", "VarianceMask", "ReferenceTypeConstraint", "NotNullableValueTypeConstraint", "DefaultConstructorConstraint", "SpecialConstraintMask", "AllowByRefLike" ], "type": "string", "description": "The string or integer value may be used. None = 0, Covariant = 1, Contravariant = 2, VarianceMask = 3, ReferenceTypeConstraint = 4, NotNullableValueTypeConstraint = 8, DefaultConstructorConstraint = 16, SpecialConstraintMask = 28, AllowByRefLike = 32" }, "GetAgentIdentificationFailureResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "existingAgentId": { "type": "integer", "format": "int32", "nullable": true }, "pendingAgentId": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "resolved": { "type": "boolean" }, "requiresManualResolution": { "type": "boolean" }, "featureUsageExceeded": { "type": "boolean" }, "manualResolutionDecision": { "$ref": "#/components/schemas/AgentIdentificationManualResolutionDecision" }, "existingComputerName": { "type": "string", "nullable": true }, "existingPrimaryUserFirstName": { "type": "string", "nullable": true }, "existingPrimaryUserLastName": { "type": "string", "nullable": true }, "existingTenantName": { "type": "string", "nullable": true }, "existingOperatingSystem": { "type": "string", "nullable": true }, "existingSerialNumber": { "type": "string", "nullable": true }, "existingManufacturer": { "type": "string", "nullable": true }, "existingOSInstallDate": { "type": "string", "format": "date-time", "nullable": true }, "existingAgent": { "$ref": "#/components/schemas/IProviderAgentDetails" } }, "additionalProperties": false }, "GetAgentSha256HashResponse": { "type": "object", "properties": { "downloadUrl": { "type": "string", "format": "uri", "nullable": true }, "agentSha256Hash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetAuthResponse": { "type": "object", "properties": { "impersonating": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "isMSP": { "type": "boolean" }, "isImmense": { "type": "boolean" }, "isSupportTechnician": { "type": "boolean" }, "isImmySupportAccessEnabled": { "type": "boolean" }, "devInstanceDetails": { "$ref": "#/components/schemas/DevInstanceDetails" }, "localSoftwareEndpoint": { "type": "string", "nullable": true }, "globalSoftwareEndpoint": { "type": "string", "nullable": true }, "localPublicMediaContainerName": { "type": "string", "nullable": true }, "globalPublicMediaContainerName": { "type": "string", "nullable": true }, "backendRegAppId": { "type": "string", "nullable": true, "readOnly": true }, "userLevelAuthSelected": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/SubscriptionStatus" }, "planId": { "type": "string", "nullable": true }, "planPrice": { "type": "integer", "format": "int32", "nullable": true }, "planQuantity": { "type": "integer", "format": "int32", "nullable": true }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddonDto" }, "nullable": true }, "trialStartUtc": { "type": "string", "format": "date-time", "nullable": true }, "trialEndUtc": { "type": "string", "format": "date-time", "nullable": true }, "updateAvailable": { "type": "boolean" }, "currentReleaseVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "currentReleaseReleaseChannel": { "$ref": "#/components/schemas/ReleaseChannel" }, "isInstanceUpdating": { "type": "boolean" }, "isInstanceRestarting": { "type": "boolean" }, "instanceUpdateHasFailed": { "type": "boolean" }, "instanceUpdateSource": { "type": "string", "nullable": true }, "maxRunningSessionCount": { "type": "integer", "format": "int32" }, "openAccessRequestCount": { "type": "integer", "format": "int32" }, "maximumTrackableComputers": { "type": "integer", "format": "int32", "nullable": true }, "canManageCrossTenantDeployments": { "type": "boolean" }, "immyProduct": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" }, "nullable": true }, "instanceReleaseChannel": { "$ref": "#/components/schemas/ReleaseChannel" }, "daysLeftInTrial": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "claims": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimResponse" }, "nullable": true } }, "additionalProperties": false }, "GetAzureGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetBashInstallScriptParameters": { "required": [ "targetExternalClientId" ], "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "targetExternalClientId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetBashInstallScriptParametersWithOnboardingOptions": { "required": [ "onboardingOptions", "targetExternalClientId" ], "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "targetExternalClientId": { "type": "string", "nullable": true }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" } }, "additionalProperties": false }, "GetBrandingResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "ignoreYear": { "type": "boolean", "nullable": true }, "timeFormat": { "type": "string", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "mascotImgUri": { "type": "string", "nullable": true }, "mascotName": { "type": "string", "nullable": true }, "logoUri": { "type": "string", "nullable": true }, "logoAltText": { "type": "string", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "foregroundColor": { "type": "string", "nullable": true }, "tableHeaderColor": { "type": "string", "nullable": true }, "tableHeaderTextColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetClaimsResponse": { "type": "object", "properties": { "claims": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimResponse" }, "description": "Collection of all claims for the user", "nullable": true } }, "additionalProperties": false, "description": "Response model for user claims information" }, "GetCommandResult": { "type": "object", "properties": { "commandType": { "$ref": "#/components/schemas/CommandTypes" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetComputerDeviceUpdateFormDataResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceUpdateFormDataResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetComputerResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "deviceId": { "type": "string", "format": "uuid", "readOnly": true }, "tenantId": { "type": "integer", "format": "int32", "readOnly": true }, "computerName": { "type": "string", "nullable": true, "readOnly": true }, "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "onboardingStatus": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "isOnline": { "type": "boolean", "readOnly": true }, "isDomainController": { "type": "boolean", "nullable": true, "readOnly": true }, "isPortable": { "type": "boolean", "nullable": true, "readOnly": true }, "isServer": { "type": "boolean", "nullable": true, "readOnly": true }, "isDesktop": { "type": "boolean", "nullable": true, "readOnly": true }, "tenantName": { "type": "string", "nullable": true, "readOnly": true }, "inventory": { "nullable": true, "readOnly": true }, "isMissingSomeRequiredInventoryResults": { "type": "boolean", "nullable": true }, "detectionOutdated": { "type": "boolean" }, "isSandbox": { "type": "boolean" }, "excludeFromMaintenance": { "type": "boolean" }, "devLabVmClaimExpirationDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "isDevLab": { "type": "boolean" }, "devLabVmUnclaimed": { "type": "boolean" }, "ephemeralAgentConnected": { "type": "boolean" }, "licensed": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "excludedFromUserAffinity": { "type": "boolean" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" }, "nullable": true, "readOnly": true }, "additionalPersons": { "type": "array", "items": { "$ref": "#/components/schemas/GetPersonResponse" }, "nullable": true, "readOnly": true }, "primaryPerson": { "$ref": "#/components/schemas/GetPersonResponse" }, "tenant": { "$ref": "#/components/schemas/GetTenantResponse" }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderAgentResponse" }, "nullable": true, "readOnly": true }, "computerTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetCustomerPortalSessionResult": { "type": "object", "properties": { "portalSessionId": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "accessUrl": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/CustomerPortalSessionStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetEphemeralAgentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isConnected": { "type": "boolean" }, "totalSentBytes": { "type": "integer", "format": "int32" }, "totalReceievedBytes": { "type": "integer", "format": "int32" }, "totalProcessedScriptCount": { "type": "integer", "format": "int32" }, "startupInfo": { "$ref": "#/components/schemas/AgentStartupInfo" }, "lastActivity": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetExecutableUriParameters": { "required": [ "targetExternalClientId" ], "type": "object", "properties": { "targetExternalClientId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetExecutableUriParametersWithOnboardingOptions": { "required": [ "onboardingOptions", "targetExternalClientId" ], "type": "object", "properties": { "targetExternalClientId": { "type": "string", "nullable": true }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" } }, "additionalProperties": false }, "GetFailedPendingAgentResponse": { "required": [ "deviceId", "externalAgentId", "externalClientName", "providerLinkName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "operatingSystemName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "externalAgentId": { "type": "string", "nullable": true }, "deviceId": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time" }, "isOnline": { "type": "boolean" }, "providerLinkName": { "type": "string", "nullable": true }, "externalClientName": { "type": "string", "nullable": true }, "osInstallDate": { "type": "string", "format": "date-time", "nullable": true }, "osInstallDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "identificationFailures": { "type": "array", "items": { "$ref": "#/components/schemas/GetAgentIdentificationFailureResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetFileDownloadUrlRequest": { "required": [ "blobName" ], "type": "object", "properties": { "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "blobName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetFunctionSyntaxRequest": { "type": "object", "properties": { "functionName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetGlobalMaintenanceTaskResponse": { "required": [ "name" ], "type": "object", "properties": { "createdDateUTC": { "type": "string", "format": "date-time" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "executeSerially": { "type": "boolean" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "icon": { "$ref": "#/components/schemas/MediaResponseBase" }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "onboardingOnly": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceTaskParameterResponse" }, "nullable": true }, "recommended": { "type": "boolean" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "useScriptParamBlock": { "type": "boolean" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "GetGlobalScriptResponse": { "required": [ "name" ], "type": "object", "properties": { "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32", "readOnly": true }, "action": { "type": "string", "nullable": true, "readOnly": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "timeout": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "GetGlobalSoftwareResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "installOrder": { "type": "integer", "format": "int32", "readOnly": true }, "hidden": { "type": "boolean", "readOnly": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32", "readOnly": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableName": { "type": "string", "nullable": true, "readOnly": true }, "softwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/GetGlobalSoftwareVersionResponse" }, "nullable": true, "readOnly": true }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/GetSoftwarePrerequisiteResponse" }, "nullable": true, "readOnly": true }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "notes": { "type": "string", "nullable": true, "readOnly": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "rebootNeeded": { "type": "boolean", "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "upgradeCode": { "type": "string", "nullable": true }, "repairType": { "$ref": "#/components/schemas/RepairActionType" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "softwareIcon": { "$ref": "#/components/schemas/GlobalMediaResponse" }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "licenseDescription": { "type": "string", "nullable": true }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "GetGlobalSoftwareVersionResponse": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true, "readOnly": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "semanticVersionString": { "type": "string", "nullable": true, "readOnly": true }, "testRequired": { "type": "boolean", "readOnly": true }, "uninstallIfNotInTarget": { "type": "boolean", "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true, "readOnly": true }, "installerFile": { "type": "string", "nullable": true, "readOnly": true }, "testFailedError": { "type": "string", "nullable": true, "readOnly": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "numActionSuccesses": { "type": "integer", "format": "int32", "readOnly": true }, "numActionFailures": { "type": "integer", "format": "int32", "readOnly": true }, "blobName": { "type": "string", "nullable": true, "readOnly": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "lastResult": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "notes": { "type": "string", "nullable": true, "readOnly": true }, "productCode": { "type": "string", "nullable": true, "readOnly": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "hasOverrides": { "type": "boolean", "readOnly": true }, "deprecatedIdField": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "softwareId": { "type": "integer", "format": "int32", "readOnly": true }, "software": { "$ref": "#/components/schemas/GetGlobalSoftwareResponse" }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetIpAddressesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GetLatestActionForComputer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "actionType": { "$ref": "#/components/schemas/MaintenanceActionType" }, "result": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "reason": { "$ref": "#/components/schemas/MaintenanceActionReason" }, "status": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "resultReason": { "$ref": "#/components/schemas/MaintenanceActionResultReason" }, "detectedVersion": { "type": "string", "nullable": true }, "desiredVersion": { "type": "string", "nullable": true }, "maintenanceDisplayName": { "type": "string", "nullable": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "assignmentId": { "type": "integer", "format": "int32", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/DatabaseType" }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "softwareActionIdForConfigurationTask": { "type": "integer", "format": "int32", "nullable": true }, "policyDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetLatestActionForComputersRequestBody": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "dateUtc": { "type": "string", "format": "date-time", "nullable": true }, "computerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" } }, "additionalProperties": false }, "GetLatestActionForTenantsRequestBody": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "dateUtc": { "type": "string", "format": "date-time", "nullable": true }, "tenantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" } }, "additionalProperties": false }, "GetLicenseResponse": { "required": [ "name", "softwareIdentifier", "softwareName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "licenseValue": { "type": "string", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true }, "softwareName": { "type": "string", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "restrictToMajorVersion": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetLocalMaintenanceTaskResponse": { "required": [ "name" ], "type": "object", "properties": { "createdDateUTC": { "type": "string", "format": "date-time" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "executeSerially": { "type": "boolean" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "icon": { "$ref": "#/components/schemas/MediaResponseBase" }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "onboardingOnly": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceTaskParameterResponse" }, "nullable": true }, "recommended": { "type": "boolean" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "useScriptParamBlock": { "type": "boolean" }, "ownerTenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLocalScriptResponse": { "required": [ "name" ], "type": "object", "properties": { "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32", "readOnly": true }, "action": { "type": "string", "nullable": true, "readOnly": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "timeout": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "updatedBy": { "type": "string", "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLocalSoftwareResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "installOrder": { "type": "integer", "format": "int32", "readOnly": true }, "hidden": { "type": "boolean", "readOnly": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32", "readOnly": true }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "readOnly": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "softwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/GetLocalSoftwareVersionResponse" }, "nullable": true, "readOnly": true }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/GetSoftwarePrerequisiteResponse" }, "nullable": true, "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "rebootNeeded": { "type": "boolean", "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "upgradeCode": { "type": "string", "nullable": true }, "repairType": { "$ref": "#/components/schemas/RepairActionType" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "softwareIcon": { "$ref": "#/components/schemas/LocalMediaResponse" }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "licenseDescription": { "type": "string", "nullable": true }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "ownerTenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLocalSoftwareVersionResponse": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true, "readOnly": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "semanticVersionString": { "type": "string", "nullable": true, "readOnly": true }, "testRequired": { "type": "boolean", "readOnly": true }, "uninstallIfNotInTarget": { "type": "boolean", "readOnly": true }, "url": { "type": "string", "nullable": true, "readOnly": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true, "readOnly": true }, "installerFile": { "type": "string", "nullable": true, "readOnly": true }, "testFailedError": { "type": "string", "nullable": true, "readOnly": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "numActionSuccesses": { "type": "integer", "format": "int32", "readOnly": true }, "numActionFailures": { "type": "integer", "format": "int32", "readOnly": true }, "blobName": { "type": "string", "nullable": true, "readOnly": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "lastResult": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "notes": { "type": "string", "nullable": true, "readOnly": true }, "productCode": { "type": "string", "nullable": true, "readOnly": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "hasOverrides": { "type": "boolean", "readOnly": true }, "deprecatedIdField": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "softwareId": { "type": "integer", "format": "int32", "readOnly": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "software": { "$ref": "#/components/schemas/GetLocalSoftwareResponse" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetMaintenanceActionResponse": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "computerName": { "type": "string", "nullable": true }, "isComputerOnline": { "type": "boolean" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "actionType": { "$ref": "#/components/schemas/MaintenanceActionType" }, "actionTypeName": { "type": "string", "nullable": true, "readOnly": true }, "status": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "statusName": { "type": "string", "nullable": true, "readOnly": true }, "assignmentId": { "type": "integer", "format": "int32", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/DatabaseType" }, "tenantName": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "description": { "type": "string", "nullable": true }, "postMaintenanceTest": { "type": "string", "nullable": true, "readOnly": true }, "postMaintenanceTestType": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "postMaintenanceTestResult": { "type": "boolean", "nullable": true, "readOnly": true }, "postMaintenanceTestResultMessage": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceTypeName": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceDisplayName": { "type": "string", "nullable": true }, "detectedVersionString": { "type": "string", "nullable": true }, "desiredVersionString": { "type": "string", "nullable": true }, "reason": { "$ref": "#/components/schemas/MaintenanceActionReason" }, "result": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "resultName": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "maintenanceTaskGetResult": { "type": "string", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "resultReason": { "$ref": "#/components/schemas/MaintenanceActionResultReason" }, "resultReasonMessage": { "type": "string", "nullable": true }, "dependsOnNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dependentsNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "softwareActionIdForConfigurationTask": { "type": "integer", "format": "int32", "nullable": true }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "policyDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetMaintenanceSessionLogResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "progressCorrelationId": { "type": "string", "format": "uuid", "nullable": true }, "sessionPhaseId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "message": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceSessionId": { "type": "integer", "format": "int32", "readOnly": true }, "maintenanceSessionStageId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "maintenanceActionStatus": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "scriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "script": { "type": "string", "nullable": true, "readOnly": true }, "scriptOutput": { "type": "string", "nullable": true, "readOnly": true }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true, "readOnly": true }, "paramBlockParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true, "readOnly": true }, "time": { "type": "string", "format": "date-time", "readOnly": true }, "updatedTime": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "sessionLogType": { "$ref": "#/components/schemas/SessionLogType" }, "scriptTimeout": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "isPrimary": { "type": "boolean", "readOnly": true }, "progressPercentComplete": { "type": "number", "format": "double", "nullable": true }, "progressActivity": { "type": "string", "nullable": true }, "progressStatus": { "type": "string", "nullable": true }, "progressSecondsRemaining": { "type": "number", "format": "double", "nullable": true }, "progressCurrentOperation": { "type": "string", "nullable": true }, "progressCompleted": { "type": "boolean" } }, "additionalProperties": false }, "GetMaintenanceSessionPhaseResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "phaseName": { "type": "string", "nullable": true }, "actionProgressPhaseName": { "$ref": "#/components/schemas/ActionProgressPhaseName" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "maintenanceSessionStageId": { "type": "integer", "format": "int32" }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true }, "status": { "$ref": "#/components/schemas/SessionPhaseStatus" }, "progressPercentComplete": { "type": "number", "format": "double", "nullable": true }, "progressStatus": { "type": "string", "nullable": true }, "progressCompleted": { "type": "boolean" }, "dateStartedUtc": { "type": "string", "format": "date-time", "nullable": true }, "dateCompletedUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetMaintenanceSessionResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "jobId": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "scheduledId": { "type": "integer", "format": "int32", "nullable": true }, "sessionStatus": { "$ref": "#/components/schemas/SessionStatus" }, "onboarding": { "type": "boolean" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "updatedById": { "type": "integer", "format": "int32", "nullable": true }, "createdById": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "fullMaintenance": { "type": "boolean" }, "computerName": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "duration": { "type": "string", "format": "date-span", "nullable": true }, "onboardingStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "detectionStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "executionStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "agentUpdatesStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "resolutionStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "inventoryStageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "sessionJobArgs": { "$ref": "#/components/schemas/SessionJobArgs" }, "scheduledExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceActions": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" }, "nullable": true }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/GetMaintenanceSessionStageResponse" }, "nullable": true }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionActivityResponse" }, "nullable": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/GetSessionLogResponse" }, "nullable": true, "readOnly": true }, "computer": { "$ref": "#/components/schemas/GetComputerResponse" }, "tenant": { "$ref": "#/components/schemas/GetTenantResponse" } }, "additionalProperties": false }, "GetMaintenanceSessionStageResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "maintenanceSessionId": { "type": "integer", "format": "int32", "readOnly": true }, "stageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "type": { "$ref": "#/components/schemas/SessionStageType" }, "jobId": { "type": "string", "nullable": true, "readOnly": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "maintenanceSession": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" } }, "additionalProperties": false }, "GetMaintenanceTaskParameterResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/MaintenanceTaskParameterType" }, "required": { "type": "boolean" }, "selectableValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notes": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "defaultMediaId": { "type": "integer", "format": "int32", "nullable": true }, "defaultMediaDatabaseType": { "$ref": "#/components/schemas/DatabaseType" }, "defaultMedia": { "$ref": "#/components/schemas/MediaResponseBase" } }, "additionalProperties": false }, "GetOnboardingComputerResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "isOnline": { "type": "boolean" }, "onboardingStatus": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "computerName": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "onboardingFailed": { "type": "boolean" }, "onboardingSessionId": { "type": "integer", "format": "int32", "nullable": true }, "serial": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetOptionalTargetAssignmentApprovalResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "targetAssignmentId": { "type": "integer", "format": "int32" }, "approved": { "$ref": "#/components/schemas/TargetAssignmentApprovalStatus" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" } }, "additionalProperties": false }, "GetPendingAgentResponse": { "required": [ "externalAgentId", "providerLinkName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "isComputerDeleted": { "type": "boolean" }, "manufacturer": { "type": "string", "nullable": true }, "operatingSystemName": { "type": "string", "nullable": true }, "externalAgentId": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "format": "date-time" }, "isOnline": { "type": "boolean" }, "serial": { "type": "string", "nullable": true }, "providerLinkName": { "type": "string", "nullable": true }, "externalClientName": { "type": "string", "nullable": true }, "osInstallDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "requiresManualResolution": { "type": "boolean", "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "identificationFailures": { "type": "array", "items": { "$ref": "#/components/schemas/GetAgentIdentificationFailureResponse" }, "nullable": true }, "requireManualIdentification": { "type": "boolean" } }, "additionalProperties": false }, "GetPendingCountsResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offline": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "manual": { "type": "integer", "format": "int32" }, "recent": { "type": "integer", "format": "int32" }, "active": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetPendingResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/GetPendingAgentResponse" }, "nullable": true } }, "additionalProperties": false }, "GetPersonResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "tenantId": { "type": "integer", "format": "int32", "readOnly": true }, "azurePrincipalId": { "type": "string", "nullable": true, "readOnly": true }, "firstName": { "type": "string", "nullable": true, "readOnly": true }, "lastName": { "type": "string", "nullable": true, "readOnly": true }, "emailAddress": { "type": "string", "nullable": true, "readOnly": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "primaryComputers": { "type": "array", "items": { "$ref": "#/components/schemas/GetComputerResponse" }, "nullable": true, "readOnly": true }, "additionalComputers": { "type": "array", "items": { "$ref": "#/components/schemas/GetComputerResponse" }, "nullable": true, "readOnly": true }, "user": { "$ref": "#/components/schemas/GetUserResponse" }, "userAffinities": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserAffinityResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetPowerShellInstallScriptParameters": { "required": [ "targetExternalClientId" ], "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "targetExternalClientId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetPowerShellInstallScriptParametersWithOnboardingOptions": { "required": [ "onboardingOptions", "targetExternalClientId" ], "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "targetExternalClientId": { "type": "string", "nullable": true }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" } }, "additionalProperties": false }, "GetPreferencesResponse": { "type": "object", "properties": { "applicationPreferences": { "$ref": "#/components/schemas/ApplicationPreferences" }, "tenantPreferences": { "$ref": "#/components/schemas/TenantPreferences" }, "userPreferences": { "$ref": "#/components/schemas/UserPreferences" } }, "additionalProperties": false }, "GetProductCatalogItemsResponse": { "type": "object", "properties": { "plans": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItemBasicInfo" }, "nullable": true }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItemBasicInfo" }, "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionFeatureBasicInfo" }, "nullable": true } }, "additionalProperties": false }, "GetProviderAgentIdentificationLogResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "providerAgentId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "logType": { "$ref": "#/components/schemas/AgentIdentificationLogType" }, "timeUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetProviderAgentResponse": { "type": "object", "properties": { "agentVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "id": { "type": "integer", "format": "int32", "readOnly": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "providerLinkId": { "type": "integer", "format": "int32", "readOnly": true }, "externalClientName": { "type": "string", "nullable": true, "readOnly": true }, "externalClientId": { "type": "string", "nullable": true }, "externalAgentId": { "$ref": "#/components/schemas/ExternalAgentId" }, "runScriptPriority": { "type": "integer", "format": "int32", "readOnly": true }, "providerTypeId": { "type": "string", "format": "uuid", "readOnly": true }, "internalData": { "nullable": true, "readOnly": true }, "isOnline": { "type": "boolean" }, "supportsRunningScripts": { "type": "boolean", "readOnly": true }, "deviceUpdateFormData": { "nullable": true }, "lastUpdatedUTC": { "type": "string", "format": "date-time", "readOnly": true }, "deviceDetails": { "$ref": "#/components/schemas/DeviceDetails" }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" }, "requireManualIdentification": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "GetProviderClientResponse": { "required": [ "externalClientId", "externalClientName" ], "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "externalClientId": { "type": "string", "nullable": true }, "linkedToTenantId": { "type": "integer", "format": "int32", "nullable": true }, "externalClientName": { "type": "string", "nullable": true }, "internalData": { "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "providerLink": { "$ref": "#/components/schemas/GetProviderLinkResponse" }, "status": { "type": "string", "nullable": true }, "types": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GetProviderLinkResponse": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "disabled": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "healthStatus": { "$ref": "#/components/schemas/HealthStatus" }, "healthStatusMessage": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "runScriptPriority": { "type": "integer", "format": "int32" }, "providerTypeFormData": { }, "inputsWithStoredPasswords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32" }, "providerTypeId": { "type": "string", "format": "uuid" }, "providerPluginBaseUrl": { "type": "string", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "includeClientsFailedMessage": { "type": "string", "nullable": true }, "getFormSchemaFailedMessage": { "type": "string", "nullable": true }, "getProviderFailedMessage": { "type": "string", "nullable": true }, "updatedByName": { "type": "string", "nullable": true }, "latestAgentVersion": { "type": "string", "nullable": true }, "getLatestAgentVersionFailedMessage": { "type": "string", "nullable": true }, "supportsDeviceUpdating": { "type": "boolean" }, "providerCapabilities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedCapabilities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "supportedCrossProviderClientLinkages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedCrossProviderLinkage" }, "nullable": true }, "supportedCrossProviderInitializationLinkages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedCrossProviderLinkage" }, "nullable": true }, "providerClients": { "type": "array", "items": { "$ref": "#/components/schemas/GetProviderClientResponse" }, "nullable": true }, "computers": { "type": "array", "items": { "$ref": "#/components/schemas/GetComputerResponse" }, "nullable": true, "readOnly": true }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/GetScheduleResponse" }, "nullable": true, "readOnly": true }, "providersLinkedFromThisProvider": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedExternalLink" }, "nullable": true, "readOnly": true }, "linkedFromProviders": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedExternalLink" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetProvisioningPackageUriParameters": { "required": [ "ppkgOptions", "targetExternalClientId" ], "type": "object", "properties": { "targetExternalClientId": { "type": "string", "nullable": true }, "ppkgOptions": { "$ref": "#/components/schemas/ProvisioningPackageOptions" } }, "additionalProperties": false }, "GetProvisioningPackageUriParametersWithOnboardingOptions": { "required": [ "onboardingOptions", "ppkgOptions", "targetExternalClientId" ], "type": "object", "properties": { "targetExternalClientId": { "type": "string", "nullable": true }, "ppkgOptions": { "$ref": "#/components/schemas/ProvisioningPackageOptions" }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" } }, "additionalProperties": false }, "GetRecommendedApprovalResponse": { "type": "object", "properties": { "globalTargetAssignmentId": { "type": "integer", "format": "int32" }, "approved": { "type": "boolean" }, "updatedBy": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetReleasesResponse": { "type": "object", "properties": { "currentRelease": { "$ref": "#/components/schemas/ReleaseDetails" }, "latestReleases": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseDetails" }, "nullable": true } }, "additionalProperties": false }, "GetRoleClaimResponse": { "required": [ "claimType", "claimValue" ], "type": "object", "properties": { "claimType": { "type": "string", "nullable": true }, "claimValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetRoleResponse": { "required": [ "createdDate", "description", "id", "name", "ownerTenantId", "ownerTenantName", "roleClaims", "roleTypeId", "roleTypeName", "updatedBy", "updatedDate", "userCount" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "roleTypeId": { "type": "integer", "format": "int32" }, "roleTypeName": { "type": "string", "nullable": true }, "userCount": { "type": "integer", "format": "int32" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "roleClaims": { "type": "array", "items": { "$ref": "#/components/schemas/GetRoleClaimResponse" }, "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetScheduleResponse": { "type": "object", "properties": { "targetText": { "type": "string", "nullable": true }, "targetTypeName": { "type": "string", "nullable": true }, "targetScopeName": { "type": "string", "nullable": true }, "targetMissing": { "type": "boolean" }, "tenantMissing": { "type": "boolean" }, "targetTypeMissing": { "type": "boolean" }, "targetTypeDescription": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "onboardingOnly": { "type": "boolean" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "targetGroupFilterName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" }, "customCronExpression": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "day": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTime": { "type": "string", "nullable": true }, "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "applyWindowsUpdates": { "type": "boolean" }, "allowAccessToMSPResources": { "type": "boolean" }, "providerLink": { "$ref": "#/components/schemas/GetProviderLinkResponse" }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedByName": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "nextOccurenceDate": { "type": "string", "format": "date-time", "nullable": true }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" } }, "additionalProperties": false }, "GetScriptNameResponse": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "updatedDateUtc": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/ScriptCategory" } }, "additionalProperties": false }, "GetScriptVariablesAndParametersRequest": { "type": "object", "properties": { "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "softwareId": { "type": "integer", "format": "int32", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "taskId": { "type": "integer", "format": "int32", "nullable": true }, "taskType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "GetScriptVariablesAndParametersResponse": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "parameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "GetSessionLogResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "message": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceSessionId": { "type": "integer", "format": "int32", "readOnly": true }, "maintenanceSessionStageId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "time": { "type": "string", "format": "date-time", "readOnly": true }, "isPrimary": { "type": "boolean", "readOnly": true }, "progressCorrelationId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "sessionPhaseId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "maintenanceActionStatus": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "scriptId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "script": { "type": "string", "nullable": true, "readOnly": true }, "scriptOutput": { "type": "string", "nullable": true, "readOnly": true }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true, "readOnly": true }, "paramBlockParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true, "readOnly": true }, "updatedTime": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "sessionLogType": { "$ref": "#/components/schemas/SessionLogType" }, "progressPercentComplete": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "progressActivity": { "type": "string", "nullable": true, "readOnly": true }, "progressStatus": { "type": "string", "nullable": true, "readOnly": true }, "progressSecondsRemaining": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "progressCurrentOperation": { "type": "string", "nullable": true, "readOnly": true }, "progressCompleted": { "type": "boolean", "readOnly": true }, "maintenanceSession": { "$ref": "#/components/schemas/GetMaintenanceSessionResponse" }, "maintenanceSessionStage": { "$ref": "#/components/schemas/GetMaintenanceSessionStageResponse" }, "maintenanceAction": { "$ref": "#/components/schemas/GetMaintenanceActionResponse" } }, "additionalProperties": false }, "GetSessionStatusCountsPayload": { "type": "object", "properties": { "counts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "total": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetSimplePersonResponse": { "required": [ "emailAddress" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "azurePrincipalId": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "fullName": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "personTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "onPremisesSecurityIdentifier": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "userCreatedDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "userCreatedBy": { "type": "string", "nullable": true }, "expirationDateUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetSmtpConfigResponse": { "required": [ "enabled", "enableSSL", "host", "port", "tenantId", "tenantName", "timeout", "username" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "host": { "type": "string", "nullable": true }, "enableSSL": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "GetSoftwarePrerequisiteResponse": { "type": "object", "properties": { "softwaresForCondition": { "type": "array", "items": { "$ref": "#/components/schemas/GetSpecifiedSoftwareResponse" }, "nullable": true, "readOnly": true }, "softwaresToPerformActionOn": { "type": "array", "items": { "$ref": "#/components/schemas/GetSpecifiedSoftwareResponse" }, "nullable": true, "readOnly": true }, "subjectQualifier": { "$ref": "#/components/schemas/SubjectQualifier" }, "condition": { "$ref": "#/components/schemas/Condition" }, "actionToPerform": { "$ref": "#/components/schemas/ActionToPerform" } }, "additionalProperties": false }, "GetSourceContextsResponse": { "type": "object", "properties": { "streamingEnabled": { "type": "boolean" }, "sourceContextLogLevels": { "type": "array", "items": { "$ref": "#/components/schemas/SourceContextLogLevel" }, "nullable": true } }, "additionalProperties": false }, "GetSpecifiedSoftwareResponse": { "type": "object", "properties": { "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetSubscriptionDetailsResponse": { "type": "object", "properties": { "planId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SubscriptionStatus" }, "trialStartUtc": { "type": "string", "format": "date-time", "nullable": true }, "trialEndUtc": { "type": "string", "format": "date-time", "nullable": true }, "subscriptionActivatedDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "featuresEnabledFromSubscription": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnabledFromSubscription" }, "nullable": true } }, "additionalProperties": false }, "GetSupportBrandingResponse": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "supportSidebarTitle": { "type": "string", "nullable": true }, "headerAlertMessage": { "type": "string", "nullable": true }, "descriptionPlaceholderText": { "type": "string", "nullable": true }, "descriptionAlertMessage": { "type": "string", "nullable": true }, "footerMessage": { "type": "string", "nullable": true }, "sessionSupportButtonTitle": { "type": "string", "nullable": true }, "showSessionSupportConfirmCheckbox": { "type": "boolean" } }, "additionalProperties": false }, "GetTagResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetTargetAssignmentTypeResponse": { "type": "object", "properties": { "targetType": { "$ref": "#/components/schemas/TargetType" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "propagateToChildTenants": { "type": "boolean", "readOnly": true }, "allowAccessToParentTenant": { "type": "boolean", "readOnly": true }, "target": { "type": "string", "nullable": true, "readOnly": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" } }, "additionalProperties": false }, "GetTenantResponse": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenantId": { "type": "integer", "format": "int32", "nullable": true }, "active": { "type": "boolean" }, "azureTenantLink": { "$ref": "#/components/schemas/AzureTenantLinkResponse" }, "isMsp": { "type": "boolean" }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "tenantTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "tenantTagNames": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "markedForDeletionAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetTenantSoftwareFromInventoryResponse": { "type": "object", "properties": { "azureUserObjectId": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "globalSoftwareId": { "type": "integer", "format": "int32" }, "globalSoftwareName": { "type": "string", "nullable": true }, "globalSoftwareVersion": { "type": "string", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "personName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "dateDetectedUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetUserAffinityResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "computerId": { "type": "integer", "format": "int32", "readOnly": true }, "personId": { "type": "integer", "format": "int32", "readOnly": true }, "date": { "type": "string", "format": "date-time", "readOnly": true }, "person": { "$ref": "#/components/schemas/GetPersonResponse" } }, "additionalProperties": false }, "GetUserResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "isAdmin": { "type": "boolean" }, "isMsp": { "type": "boolean" }, "companyName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "azurePrincipalId": { "type": "string", "nullable": true }, "isExpired": { "type": "boolean" }, "expirationDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "canManageCrossTenantDeployments": { "type": "boolean" }, "groupCount": { "type": "integer", "format": "int32" }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "directRoleCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GettingStartedChecklist": { "type": "object", "properties": { "enableGettingStartedWizard": { "type": "boolean" }, "activatedTrial": { "type": "boolean" }, "installedImmyAgent": { "type": "boolean" }, "ranOnboardingSession": { "type": "boolean" } }, "additionalProperties": false }, "GlobalMediaResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "fileName": { "type": "string", "nullable": true, "readOnly": true }, "mimeType": { "type": "string", "nullable": true, "readOnly": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "blobReference": { "type": "string", "nullable": true, "readOnly": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true, "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "category": { "$ref": "#/components/schemas/MediaCategory" } }, "additionalProperties": false }, "GlobalSoftware": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "softwareTableName": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "detectionScript": { "$ref": "#/components/schemas/Script" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScript": { "$ref": "#/components/schemas/Script" }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeCode": { "type": "string", "nullable": true }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "repairType": { "$ref": "#/components/schemas/RepairActionType" }, "repairScript": { "$ref": "#/components/schemas/Script" }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "useSoftwareTableDetection": { "type": "boolean", "deprecated": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScript": { "$ref": "#/components/schemas/Script" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScript": { "$ref": "#/components/schemas/Script" }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScript": { "$ref": "#/components/schemas/Script" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScript": { "$ref": "#/components/schemas/Script" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScript": { "$ref": "#/components/schemas/Script" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScript": { "$ref": "#/components/schemas/Script" }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "licenseDescription": { "type": "string", "nullable": true }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "dynamicVersionsScript": { "$ref": "#/components/schemas/Script" }, "relativeCacheSourcePath": { "type": "string", "format": "uuid" }, "maintenanceSpecifier": { "$ref": "#/components/schemas/MaintenanceSpecifier" }, "id": { "type": "integer", "format": "int32" }, "softwareIcon": { "$ref": "#/components/schemas/Media" }, "softwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSoftwareVersion" }, "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true, "readOnly": true }, "customAuditProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AuditPropertyChange" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GlobalSoftwareVersion": { "required": [ "semanticVersion" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "semanticVersionString": { "type": "string", "nullable": true, "readOnly": true }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "blobName": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "numActionSuccesses": { "type": "integer", "format": "int32" }, "numActionFailures": { "type": "integer", "format": "int32" }, "lastResult": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "notes": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScript": { "$ref": "#/components/schemas/Script" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScript": { "$ref": "#/components/schemas/Script" }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScript": { "$ref": "#/components/schemas/Script" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScript": { "$ref": "#/components/schemas/Script" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScript": { "$ref": "#/components/schemas/Script" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScript": { "$ref": "#/components/schemas/Script" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "architecture": { "$ref": "#/components/schemas/Architecture" }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "deprecatedIdField": { "type": "integer", "format": "int32", "nullable": true }, "softwareId": { "type": "integer", "format": "int32" }, "software": { "$ref": "#/components/schemas/GlobalSoftware" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GlobalTargetAssignmentResource": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "targetText": { "type": "string", "nullable": true }, "targetTypeName": { "type": "string", "nullable": true }, "targetScopeName": { "type": "string", "nullable": true }, "targetMissing": { "type": "boolean" }, "tenantMissing": { "type": "boolean" }, "targetTypeMissing": { "type": "boolean" }, "targetTypeDescription": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "onboardingOnly": { "type": "boolean" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "targetGroupFilterName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "isCore": { "type": "boolean" }, "excluded": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "notes": { "type": "string", "nullable": true }, "notesUpdatedByUserName": { "type": "string", "nullable": true }, "notesUpdatedUtc": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareSemanticVersionString": { "type": "string", "nullable": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "licenseName": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "integrationTypeId": { "type": "string", "nullable": true }, "integrationPrompt": { "type": "string", "nullable": true }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetVisibility": { "$ref": "#/components/schemas/TargetAssignmentVisibilityResource" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "GrantAccessRequest": { "type": "object", "properties": { "expirationTime": { "$ref": "#/components/schemas/ExpirationTime" } }, "additionalProperties": false }, "GrantAccessResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Group": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "groupTypeId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "description": { "maxLength": 500, "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "groupType": { "$ref": "#/components/schemas/GroupType" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "nullable": true }, "groupRoleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignment" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "auditObjectName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GroupDto": { "required": [ "createdDate", "description", "groupTypeId", "id", "name", "tenantId", "tenantName", "updatedBy", "updatedDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "groupTypeId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupMemberDto": { "required": [ "addedBy", "addedDate", "groupDescription", "groupId", "groupName", "userEmail", "userId", "userName" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32" }, "userName": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "addedDate": { "type": "string", "format": "date-time" }, "addedBy": { "type": "string", "nullable": true }, "groupDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupingInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "desc": { "type": "boolean" }, "groupInterval": { "type": "string", "nullable": true }, "isExpanded": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "HealthStatus": { "enum": [ "Unhealthy", "Degraded", "Healthy" ], "type": "string", "description": "The string or integer value may be used. Unhealthy = 0, Degraded = 1, Healthy = 2" }, "IClientGroup": { "type": "object", "properties": { "clientGroupDisplayName": { "type": "string", "nullable": true, "readOnly": true }, "clientGroupId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IClientStatus": { "type": "object", "properties": { "clientStatusDisplayName": { "type": "string", "nullable": true, "readOnly": true }, "clientStatusId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IClientType": { "type": "object", "properties": { "clientTypeDisplayName": { "type": "string", "nullable": true, "readOnly": true }, "clientTypeId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "IDeviceGroup": { "type": "object", "properties": { "deviceGroupDisplayName": { "type": "string", "nullable": true, "readOnly": true }, "deviceGroupId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IPermissionMetadata": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "permissionName": { "type": "string", "nullable": true, "readOnly": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "category": { "$ref": "#/components/schemas/PermissionCategory" }, "sortOrder": { "type": "integer", "format": "int32", "readOnly": true }, "hasGreatPower": { "type": "boolean", "readOnly": true }, "dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/IPermissionMetadata" }, "nullable": true, "readOnly": true }, "subject": { "$ref": "#/components/schemas/ISubjectMetadata" }, "isMspOnly": { "type": "boolean", "readOnly": true }, "isSystemManaged": { "type": "boolean", "readOnly": true }, "allowClaim": { "type": "string", "nullable": true, "readOnly": true }, "subjectPermissionClaimType": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IProviderAgentDetails": { "type": "object", "properties": { "agentVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "externalClientId": { "type": "string", "nullable": true }, "externalAgentId": { "$ref": "#/components/schemas/ExternalAgentId" }, "internalData": { "nullable": true, "readOnly": true }, "isOnline": { "type": "boolean", "readOnly": true }, "lastUpdatedUTC": { "type": "string", "format": "date-time", "readOnly": true }, "supportsRunningScripts": { "type": "boolean", "readOnly": true }, "deviceDetails": { "$ref": "#/components/schemas/DeviceDetails" }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" }, "requireManualIdentification": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "IScript": { "type": "object", "properties": { "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "script": { "type": "string", "nullable": true, "readOnly": true }, "timeout": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "IScriptDetailsBase": { "type": "object", "properties": { "action": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "timeout": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" } }, "additionalProperties": false }, "ISubjectMetadata": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "sortOrder": { "type": "integer", "format": "int32", "readOnly": true }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/IPermissionMetadata" }, "nullable": true, "readOnly": true }, "isMspOnly": { "type": "boolean", "readOnly": true }, "isResourceBased": { "type": "boolean", "readOnly": true }, "isSystemManaged": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "IdentifyAgentRequest": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "agentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "ImmyIpAndHostnamesResponse": { "type": "object", "properties": { "ipInfo": { "$ref": "#/components/schemas/GetIpAddressesResponse" }, "localBlobStorageEndpoint": { "type": "string", "nullable": true }, "globalBlobStorageEndpoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImpersonationRequest": { "type": "object", "properties": { "expiresAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Int32OpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IntPtr": { "type": "object", "additionalProperties": false }, "IntegrationBindParametersRequest": { "type": "object", "properties": { "parameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ParameterValue" }, "description": "The parameter values to bind.", "nullable": true }, "providerLinkId": { "type": "integer", "description": "Optionally provide a provider link id that will be used to supply password values stored in the provider link if the parameter values in this request do not contain values for the password fields.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IntegrationTag": { "enum": [ "Developer", "Alpha", "Beta", "Production" ], "type": "string", "description": "The string or integer value may be used. Developer = 1, Alpha = 2, Beta = 3, Production = 4" }, "InventoryDeviceCmdResponse": { "type": "object", "properties": { "success": { "type": "boolean", "readOnly": true }, "failureReason": { "type": "string", "nullable": true, "readOnly": true }, "output": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "InventoryTask": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "inventoryTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "fromProvider": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "frequency": { "$ref": "#/components/schemas/InventoryTaskFrequency" }, "specifiedNumMinutes": { "type": "integer", "format": "int32", "nullable": true }, "scripts": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTaskScript" }, "nullable": true, "readOnly": true }, "frequencyTimespan": { "type": "string", "format": "date-span", "readOnly": true } }, "additionalProperties": false }, "InventoryTaskFrequency": { "enum": [ "SpecifiedNumMinutes", "EveryMinute", "Hourly", "Daily", "Weekly" ], "type": "string", "description": "The string or integer value may be used. SpecifiedNumMinutes = 0, EveryMinute = 1, Hourly = 2, Daily = 3, Weekly = 4" }, "InventoryTaskPayload": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "frequency": { "$ref": "#/components/schemas/InventoryTaskFrequency" } }, "additionalProperties": false }, "InventoryTaskResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "inventoryTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "frequency": { "$ref": "#/components/schemas/InventoryTaskFrequency" }, "specifiedNumMinutes": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "scripts": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTaskScriptResource" }, "nullable": true, "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "fromProvider": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "InventoryTaskScript": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "inventoryTaskId": { "type": "integer", "format": "int32" }, "inventoryKey": { "type": "string", "nullable": true }, "scriptId": { "type": "integer", "format": "int32" }, "fromProvider": { "type": "boolean" }, "saveInformationStream": { "type": "boolean" }, "saveWarningStream": { "type": "boolean" }, "saveVerboseStream": { "type": "boolean" }, "saveDebugStream": { "type": "boolean" }, "inventoryTask": { "$ref": "#/components/schemas/InventoryTask" }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "InventoryTaskScriptPayload": { "type": "object", "properties": { "inventoryTaskId": { "type": "integer", "format": "int32" }, "inventoryKey": { "type": "string", "nullable": true }, "scriptId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "InventoryTaskScriptResource": { "type": "object", "properties": { "inventoryKey": { "type": "string", "nullable": true, "readOnly": true }, "scriptId": { "type": "integer", "format": "int32", "readOnly": true }, "fromProvider": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LayoutKind": { "enum": [ "Sequential", "Explicit", "Auto" ], "type": "string", "description": "The string or integer value may be used. Sequential = 0, Explicit = 2, Auto = 3" }, "License": { "required": [ "name", "softwareIdentifier", "softwareName" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "licenseValue": { "type": "string", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true }, "softwareName": { "type": "string", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "restrictToMajorVersion": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "targetAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignment" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "LicenseType": { "enum": [ "None", "LicenseFile", "Key" ], "type": "string", "description": "The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2" }, "LinkClientToNewTenantRequestBody": { "required": [ "externalClientId" ], "type": "object", "properties": { "externalClientId": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LinkClientToNewTenantResponseBody": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LinkClientsToTenantRequestBody": { "required": [ "clientIds" ], "type": "object", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LinkedExternalLink": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "providerLinkName": { "type": "string", "nullable": true }, "providerTypeId": { "type": "string", "format": "uuid" }, "isExternalClientLinkingEnabled": { "type": "boolean" }, "isExternalProviderInitializedFromThisProvider": { "type": "boolean" } }, "additionalProperties": false }, "LoadResult": { "type": "object", "properties": { "data": { "type": "array", "items": { }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32", "default": -1 }, "groupCount": { "type": "integer", "format": "int32", "default": -1 }, "summary": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "LocalMediaResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "fileName": { "type": "string", "nullable": true, "readOnly": true }, "mimeType": { "type": "string", "nullable": true, "readOnly": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "blobReference": { "type": "string", "nullable": true, "readOnly": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true, "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "category": { "$ref": "#/components/schemas/MediaCategory" }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocalSoftware": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "softwareTableName": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "detectionScript": { "$ref": "#/components/schemas/Script" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScript": { "$ref": "#/components/schemas/Script" }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeCode": { "type": "string", "nullable": true }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "repairType": { "$ref": "#/components/schemas/RepairActionType" }, "repairScript": { "$ref": "#/components/schemas/Script" }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "useSoftwareTableDetection": { "type": "boolean", "deprecated": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScript": { "$ref": "#/components/schemas/Script" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScript": { "$ref": "#/components/schemas/Script" }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScript": { "$ref": "#/components/schemas/Script" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScript": { "$ref": "#/components/schemas/Script" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScript": { "$ref": "#/components/schemas/Script" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScript": { "$ref": "#/components/schemas/Script" }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "licenseDescription": { "type": "string", "nullable": true }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "dynamicVersionsScript": { "$ref": "#/components/schemas/Script" }, "relativeCacheSourcePath": { "type": "string", "format": "uuid" }, "maintenanceSpecifier": { "$ref": "#/components/schemas/MaintenanceSpecifier" }, "id": { "type": "integer", "format": "int32" }, "ownerTenantId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "tenantId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "authorizedViewers": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftwareViewer" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "tenantSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/TenantSoftware" }, "nullable": true, "deprecated": true }, "softwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftwareVersion" }, "nullable": true }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true, "readOnly": true }, "softwareIcon": { "$ref": "#/components/schemas/Media" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "customAuditProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AuditPropertyChange" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "LocalSoftwareVersion": { "required": [ "semanticVersion" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "semanticVersionString": { "type": "string", "nullable": true, "readOnly": true }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "blobName": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "numActionSuccesses": { "type": "integer", "format": "int32" }, "numActionFailures": { "type": "integer", "format": "int32" }, "lastResult": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "notes": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScript": { "$ref": "#/components/schemas/Script" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScript": { "$ref": "#/components/schemas/Script" }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScript": { "$ref": "#/components/schemas/Script" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScript": { "$ref": "#/components/schemas/Script" }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScript": { "$ref": "#/components/schemas/Script" }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScript": { "$ref": "#/components/schemas/Script" }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "architecture": { "$ref": "#/components/schemas/Architecture" }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "deprecatedIdField": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "softwareId": { "type": "integer", "format": "int32" }, "software": { "$ref": "#/components/schemas/LocalSoftware" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "LocalSoftwareViewer": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "localSoftwareId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "localSoftware": { "$ref": "#/components/schemas/LocalSoftware" } }, "additionalProperties": false }, "LocalTargetAssignmentResource": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "targetText": { "type": "string", "nullable": true }, "targetTypeName": { "type": "string", "nullable": true }, "targetScopeName": { "type": "string", "nullable": true }, "targetMissing": { "type": "boolean" }, "tenantMissing": { "type": "boolean" }, "targetTypeMissing": { "type": "boolean" }, "targetTypeDescription": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "onboardingOnly": { "type": "boolean" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "targetGroupFilterName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "isCore": { "type": "boolean" }, "excluded": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "notes": { "type": "string", "nullable": true }, "notesUpdatedByUserName": { "type": "string", "nullable": true }, "notesUpdatedUtc": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareSemanticVersionString": { "type": "string", "nullable": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "licenseName": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "integrationTypeId": { "type": "string", "nullable": true }, "integrationPrompt": { "type": "string", "nullable": true }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetVisibility": { "$ref": "#/components/schemas/TargetAssignmentVisibilityResource" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "LogLevel": { "enum": [ "Trace", "Debug", "Information", "Warning", "Error", "Critical", "None" ], "type": "string", "description": "The string or integer value may be used. Trace = 0, Debug = 1, Information = 2, Warning = 3, Error = 4, Critical = 5, None = 6" }, "MaintenanceAction": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "assignmentId": { "type": "integer", "format": "int32", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceDisplayName": { "type": "string", "nullable": true }, "actionType": { "$ref": "#/components/schemas/MaintenanceActionType" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "detectedVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "detectedVersionString": { "type": "string", "nullable": true, "readOnly": true }, "hasDeterminedDetectedVersion": { "type": "boolean" }, "desiredVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "desiredVersionString": { "type": "string", "nullable": true, "readOnly": true }, "hasDeterminedDesiredVersion": { "type": "boolean" }, "maintenanceTaskGetResult": { "type": "string", "nullable": true }, "hasDeterminedTaskGetResult": { "type": "boolean" }, "taskTestResult": { "type": "boolean", "nullable": true }, "hasDeterminedTaskTestResult": { "type": "boolean" }, "softwareActionIdForConfigurationTask": { "type": "integer", "format": "int32", "nullable": true }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "actionStatus": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "actionReason": { "$ref": "#/components/schemas/MaintenanceActionReason" }, "actionResult": { "$ref": "#/components/schemas/MaintenanceActionResult" }, "actionResultReason": { "$ref": "#/components/schemas/MaintenanceActionResultReason" }, "policyDescription": { "type": "string", "nullable": true }, "actionResultReasonMessage": { "type": "string", "nullable": true }, "postMaintenanceTest": { "type": "string", "nullable": true }, "postMaintenanceTestType": { "type": "integer", "format": "int32", "nullable": true }, "postMaintenanceTestResult": { "type": "boolean", "nullable": true }, "postMaintenanceTestResultMessage": { "type": "string", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "softwareTableRegexString": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "softwareActionIdForConfigurationTaskOrId": { "type": "integer", "format": "int32", "readOnly": true }, "isStarted": { "type": "boolean", "readOnly": true }, "isComplete": { "type": "boolean", "readOnly": true }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SessionLog" }, "nullable": true, "readOnly": true }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/SessionPhase" }, "nullable": true, "readOnly": true }, "dependsOn": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionDependency" }, "nullable": true, "readOnly": true }, "dependents": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionDependency" }, "nullable": true, "readOnly": true }, "dependsOnActions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceAction" }, "nullable": true, "readOnly": true }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionActivity" }, "nullable": true, "readOnly": true }, "lastAction": { "type": "string", "nullable": true, "deprecated": true }, "lastActionResult": { "type": "string", "nullable": true, "deprecated": true }, "lastActionType": { "$ref": "#/components/schemas/ScriptLanguage" }, "lastActionRmmComputerId": { "type": "string", "nullable": true, "deprecated": true }, "parameters": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "usesManualProgressControl": { "type": "boolean" } }, "additionalProperties": false }, "MaintenanceActionActivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "maintenanceActionId": { "type": "integer", "format": "int32" }, "scriptName": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "currentOperation": { "type": "string", "nullable": true }, "activityId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "percentComplete": { "type": "integer", "format": "int32", "nullable": true }, "secondsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "sourceId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "completed": { "type": "boolean", "nullable": true }, "dateUtc": { "type": "string", "format": "date-time" }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" }, "maintenanceAction": { "$ref": "#/components/schemas/MaintenanceAction" } }, "additionalProperties": false }, "MaintenanceActionActivityResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "maintenanceActionId": { "type": "integer", "format": "int32" }, "activity": { "type": "string", "nullable": true }, "currentOperation": { "type": "string", "nullable": true }, "activityId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "percentComplete": { "type": "integer", "format": "int32", "nullable": true }, "secondsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "sourceId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "completed": { "type": "boolean", "nullable": true }, "dateUtc": { "type": "string", "format": "date-time" }, "scriptName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MaintenanceActionDependency": { "type": "object", "properties": { "dependentId": { "type": "integer", "format": "int32" }, "dependsOnId": { "type": "integer", "format": "int32" }, "dependent": { "$ref": "#/components/schemas/MaintenanceAction" }, "dependsOn": { "$ref": "#/components/schemas/MaintenanceAction" } }, "additionalProperties": false }, "MaintenanceActionReason": { "enum": [ "SoftwareMissing", "UpdateAvailable", "UpToDate", "NotAssigned", "TestFailed", "SoftwareDetected", "OlderVersionRequired", "NoApplicableSoftwareVersion", "NoAction", "Undetermined", "TaskEnforce", "TaskAudit", "TaskMonitor", "TaskNotCompliant", "TaskCompliant", "DeviceOffline", "RepairTriggered" ], "type": "string", "description": "The string or integer value may be used. SoftwareMissing = 0, UpdateAvailable = 1, UpToDate = 2, NotAssigned = 3, TestFailed = 4, SoftwareDetected = 5, OlderVersionRequired = 6, NoApplicableSoftwareVersion = 7, NoAction = 8, Undetermined = 9, TaskEnforce = 10, TaskAudit = 11, TaskMonitor = 12, TaskNotCompliant = 13, TaskCompliant = 14, DeviceOffline = 15, RepairTriggered = 16" }, "MaintenanceActionResult": { "enum": [ "Pending", "Success", "Failed", "Cancelled", "Indeterminable", "Resolved" ], "type": "string", "description": "The string or integer value may be used. Pending = 0, Success = 1, Failed = 2, Cancelled = 3, Indeterminable = 4, Resolved = 5" }, "MaintenanceActionResultReason": { "enum": [ "NoLicenseAvailable", "SoftwareNotFound", "DetectionActionFailed", "TaskNotFound", "TaskNotCompliant", "TaskCompliant", "TaskSetIsMissing", "TaskTestIsMissing", "TaskGetIsMissing", "SoftwareConfigurationTaskMissing", "TaskModeIsMissing", "DeviceOffline", "RebootsSuppressed" ], "type": "string", "description": "The string or integer value may be used. NoLicenseAvailable = 0, SoftwareNotFound = 1, DetectionActionFailed = 2, TaskNotFound = 3, TaskNotCompliant = 4, TaskCompliant = 5, TaskSetIsMissing = 6, TaskTestIsMissing = 7, TaskGetIsMissing = 8, SoftwareConfigurationTaskMissing = 9, TaskModeIsMissing = 10, DeviceOffline = 11, RebootsSuppressed = 12" }, "MaintenanceActionStatus": { "enum": [ "NotStarted", "Downloading", "PerformingAction", "DeterminingResult", "Complete", "WaitingForPrerequisite", "DeterminingAction", "Skipped", "PendingExecution" ], "type": "string", "description": "The string or integer value may be used. NotStarted = 0, Downloading = 1, PerformingAction = 2, DeterminingResult = 3, Complete = 4, WaitingForPrerequisite = 5, DeterminingAction = 6, Skipped = 7, PendingExecution = 8" }, "MaintenanceActionType": { "enum": [ "NoAction", "Install", "Update", "Uninstall", "Download", "Reinstall", "Downgrade", "Undetermined", "TaskEnforce", "TaskMonitor", "TaskAudit" ], "type": "string", "description": "The string or integer value may be used. NoAction = 0, Install = 1, Update = 2, Uninstall = 3, Download = 4, Reinstall = 5, Downgrade = 6, Undetermined = 7, TaskEnforce = 8, TaskMonitor = 9, TaskAudit = 10" }, "MaintenanceAgentUpdatesConfiguration": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "MaintenanceEmailConfiguration": { "type": "object", "properties": { "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" } }, "additionalProperties": false }, "MaintenanceItem": { "type": "object", "properties": { "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "MaintenanceItemOrder": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "sortOrder": { "type": "number", "format": "double" }, "location": { "$ref": "#/components/schemas/MaintenanceItemOrderLocation" } }, "additionalProperties": false }, "MaintenanceItemOrderLocation": { "enum": [ "Beginning", "DontCare", "End" ], "type": "string", "description": "The string or integer value may be used. Beginning = 1, DontCare = 2, End = 3" }, "MaintenanceOnboardingConfiguration": { "type": "object", "properties": { "onboardingOnlyParameterValueOverrides": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "nullable": true }, "onboardingOnlyMaintenanceTaskParameterValueOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterValueDetails" }, "nullable": true, "deprecated": true }, "automaticOnboarding": { "type": "boolean" } }, "additionalProperties": false }, "MaintenanceSchedulingConfiguration": { "type": "object", "properties": { "time": { "type": "string", "nullable": true }, "maintenanceTime": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" } }, "additionalProperties": false }, "MaintenanceSession": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "jobId": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "scheduledId": { "type": "integer", "format": "int32", "nullable": true }, "sessionStatus": { "$ref": "#/components/schemas/SessionStatus" }, "onboarding": { "type": "boolean" }, "scheduledExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "duration": { "type": "string", "format": "date-span", "nullable": true }, "usingActiveHours": { "type": "boolean" }, "fullMaintenance": { "type": "boolean" }, "jobArgs": { "$ref": "#/components/schemas/SessionJobArgs" }, "activeSession": { "$ref": "#/components/schemas/ActiveSession" }, "maintenanceActions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceAction" }, "nullable": true }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceSessionStage" }, "nullable": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SessionLog" }, "nullable": true }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/SessionPhase" }, "nullable": true }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionActivity" }, "nullable": true, "readOnly": true }, "computer": { "$ref": "#/components/schemas/Computer" }, "person": { "$ref": "#/components/schemas/Person" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "createdByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "MaintenanceSessionStage": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "stageStatus": { "$ref": "#/components/schemas/SessionStatus" }, "type": { "$ref": "#/components/schemas/SessionStageType" }, "jobId": { "type": "string", "nullable": true }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SessionLog" }, "nullable": true }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/SessionPhase" }, "nullable": true } }, "additionalProperties": false }, "MaintenanceSpecifier": { "required": [ "maintenanceIdentifier", "maintenanceType" ], "type": "object", "properties": { "maintenanceName": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MaintenanceTask": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "onboardingOnly": { "type": "boolean" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "executeSerially": { "type": "boolean" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "recommended": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "useScriptParamBlock": { "type": "boolean" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameter" }, "nullable": true }, "tenantRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/TenantMaintenanceTask" }, "nullable": true, "deprecated": true }, "setScript": { "$ref": "#/components/schemas/Script" }, "getScript": { "$ref": "#/components/schemas/Script" }, "testScript": { "$ref": "#/components/schemas/Script" }, "icon": { "$ref": "#/components/schemas/Media" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "tenantId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "authorizedViewers": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskViewer" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "MaintenanceTaskCategory": { "enum": [ "Computer", "Tenant", "Person" ], "type": "string", "description": "The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2" }, "MaintenanceTaskMode": { "enum": [ "Enforce", "Audit", "Monitor", "NoAction" ], "type": "string", "description": "The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3" }, "MaintenanceTaskParameter": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/MaintenanceTaskParameterType" }, "required": { "type": "boolean" }, "selectableValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notes": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "defaultMediaId": { "type": "integer", "format": "int32", "nullable": true }, "defaultMediaDatabaseType": { "$ref": "#/components/schemas/DatabaseType" }, "defaultMedia": { "$ref": "#/components/schemas/Media" }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" } }, "additionalProperties": false }, "MaintenanceTaskParameterPayload": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/MaintenanceTaskParameterType" }, "required": { "type": "boolean" }, "selectableValues": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "notes": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "defaultMediaId": { "type": "integer", "format": "int32", "nullable": true }, "defaultMediaDatabaseType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "MaintenanceTaskParameterType": { "enum": [ "Number", "Text", "Boolean", "Select", "Password", "File", "Uri", "KeyValuePair" ], "type": "string", "description": "The string or integer value may be used. Number = 0, Text = 1, Boolean = 2, Select = 3, Password = 4, File = 5, Uri = 6, KeyValuePair = 7" }, "MaintenanceTaskParameterValue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true }, "deploymentId": { "type": "integer", "format": "int32" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "maintenanceTaskParameterId": { "type": "integer", "format": "int32" }, "mediaId": { "type": "integer", "format": "int32", "nullable": true }, "mediaDatabaseType": { "$ref": "#/components/schemas/DatabaseType" }, "deployment": { "$ref": "#/components/schemas/TargetAssignment" }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" }, "maintenanceTaskParameter": { "$ref": "#/components/schemas/MaintenanceTaskParameter" }, "media": { "$ref": "#/components/schemas/Media" }, "allowOverrideFromComputerOnboarding": { "type": "boolean" }, "parameterName": { "type": "string", "nullable": true }, "parameterType": { "$ref": "#/components/schemas/MaintenanceTaskParameterType" } }, "additionalProperties": false }, "MaintenanceTaskParameterValueDetails": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true }, "deploymentId": { "type": "integer", "format": "int32" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "maintenanceTaskParameterId": { "type": "integer", "format": "int32" }, "mediaId": { "type": "integer", "format": "int32", "nullable": true }, "mediaDatabaseType": { "$ref": "#/components/schemas/DatabaseType" }, "allowOverrideFromComputerOnboarding": { "type": "boolean" }, "parameterName": { "type": "string", "nullable": true }, "parameterType": { "$ref": "#/components/schemas/MaintenanceTaskParameterType" } }, "additionalProperties": false }, "MaintenanceTaskSearchResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "useScriptParamBlock": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MaintenanceTaskViewer": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" } }, "additionalProperties": false }, "MaintenanceType": { "enum": [ "GlobalSoftware", "LocalSoftware", "WindowsUpdate", "ChocolateySoftware", "NiniteSoftware", "LocalMaintenanceTask", "GlobalMaintenanceTask", "AgentUpdate" ], "type": "string", "description": "The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7" }, "Media": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "blobReference": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/MediaCategory" }, "localSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftware" }, "nullable": true, "readOnly": true }, "globalSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSoftware" }, "nullable": true, "readOnly": true }, "iconForMaintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTask" }, "nullable": true, "readOnly": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "dynamicIntegrationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicIntegrationType" }, "nullable": true, "readOnly": true }, "tenantRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/TenantMedia" }, "nullable": true, "readOnly": true, "deprecated": true }, "authorizedViewers": { "type": "array", "items": { "$ref": "#/components/schemas/MediaViewer" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" } }, "additionalProperties": false }, "MediaCategory": { "enum": [ "None", "SoftwareIcon" ], "type": "string", "description": "The string or integer value may be used. None = 0, SoftwareIcon = 1" }, "MediaResponseBase": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "fileName": { "type": "string", "nullable": true, "readOnly": true }, "mimeType": { "type": "string", "nullable": true, "readOnly": true }, "packageHash": { "type": "string", "nullable": true, "readOnly": true }, "blobReference": { "type": "string", "nullable": true, "readOnly": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true, "readOnly": true }, "updatedDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "createdDateUTC": { "type": "string", "format": "date-time", "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "category": { "$ref": "#/components/schemas/MediaCategory" } }, "additionalProperties": false }, "MediaSearchResponse": { "type": "object", "properties": { "global": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalMediaResponse" }, "nullable": true, "readOnly": true }, "local": { "type": "array", "items": { "$ref": "#/components/schemas/LocalMediaResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "MediaViewer": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "mediaId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "media": { "$ref": "#/components/schemas/Media" } }, "additionalProperties": false }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ], "type": "string", "description": "The string or integer value may be used. Constructor = 1, Event = 2, Field = 4, Method = 8, Property = 16, TypeInfo = 32, Custom = 64, NestedType = 128, All = 191" }, "MergeTenantsPayload": { "type": "object", "properties": { "targetTenantId": { "type": "integer", "format": "int32" }, "tenantsToMerge": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "MethodAttributes": { "enum": [ "PrivateScope", "ReuseSlot", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "MemberAccessMask", "UnmanagedExport", "Static", "Final", "Virtual", "HideBySig", "NewSlot", "VtableLayoutMask", "CheckAccessOnOverride", "Abstract", "SpecialName", "RTSpecialName", "PinvokeImpl", "HasSecurity", "RequireSecObject", "ReservedMask" ], "type": "string", "description": "The string or integer value may be used. PrivateScope = 0, ReuseSlot = 0, Private = 1, FamANDAssem = 2, Assembly = 3, Family = 4, FamORAssem = 5, Public = 6, MemberAccessMask = 7, UnmanagedExport = 8, Static = 16, Final = 32, Virtual = 64, HideBySig = 128, NewSlot = 256, VtableLayoutMask = 256, CheckAccessOnOverride = 512, Abstract = 1024, SpecialName = 2048, RTSpecialName = 4096, PinvokeImpl = 8192, HasSecurity = 16384, RequireSecObject = 32768, ReservedMask = 53248" }, "MethodBase": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MethodImplAttributes": { "enum": [ "IL", "Managed", "Native", "OPTIL", "CodeTypeMask", "Runtime", "ManagedMask", "Unmanaged", "NoInlining", "ForwardRef", "Synchronized", "NoOptimization", "PreserveSig", "AggressiveInlining", "AggressiveOptimization", "InternalCall", "Async", "MaxMethodImplVal" ], "type": "string", "description": "The string or integer value may be used. IL = 0, Managed = 0, Native = 1, OPTIL = 2, CodeTypeMask = 3, Runtime = 3, ManagedMask = 4, Unmanaged = 4, NoInlining = 8, ForwardRef = 16, Synchronized = 32, NoOptimization = 64, PreserveSig = 128, AggressiveInlining = 256, AggressiveOptimization = 512, InternalCall = 4096, Async = 8192, MaxMethodImplVal = 65535" }, "MethodInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "$ref": "#/components/schemas/Type" }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" } }, "additionalProperties": false }, "MigrateToSupersedingAssignmentRequest": { "type": "object", "properties": { "oldAssignmentId": { "type": "integer", "format": "int32" }, "newTaskId": { "type": "integer", "format": "int32" }, "newTaskType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "MigrateToSupersedingAssignmentWhatIfResponse": { "type": "object", "properties": { "isNew": { "type": "boolean" }, "assignment": { "$ref": "#/components/schemas/LocalTargetAssignmentResource" }, "policyDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MigrateToSupersedingAssignmentWhatIfResponseOpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/MigrateToSupersedingAssignmentWhatIfResponse" } }, "additionalProperties": false }, "MigrationPreviewResponse": { "type": "object", "properties": { "software": { "type": "array", "items": { "$ref": "#/components/schemas/MigratorDataDto" }, "nullable": true, "readOnly": true }, "softwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/MigratorDataDto" }, "nullable": true, "readOnly": true }, "maintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/MigratorDataDto" }, "nullable": true, "readOnly": true }, "scripts": { "type": "array", "items": { "$ref": "#/components/schemas/MigratorDataDto" }, "nullable": true, "readOnly": true }, "softwareHasLocalPrerequisites": { "type": "boolean" } }, "additionalProperties": false }, "MigratorDataDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MissingAccessTokenDetails": { "type": "object", "properties": { "tenantId": { "type": "string", "nullable": true }, "requiredScopes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MsalErrorDetails": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "errorDescription": { "type": "string", "nullable": true }, "errorCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "timestamp": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MspAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "mspTenantId": { "type": "integer", "format": "int32" }, "mspTenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MspInstanceImmySupportAccessGrantDetails": { "required": [ "enabledByEmail", "enabledByName", "enabledDateUtc", "isEnabled" ], "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "enabledByName": { "type": "string", "nullable": true }, "enabledByEmail": { "type": "string", "nullable": true }, "enabledDateUtc": { "type": "string", "format": "date-time" }, "disabledByName": { "type": "string", "nullable": true }, "disabledByEmail": { "type": "string", "nullable": true }, "disabledDateUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MyComputerResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isOnline": { "type": "boolean" } }, "additionalProperties": false }, "MyPermissionsResponse": { "required": [ "groups", "roleAssignments", "tenantPermissions" ], "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberDto" }, "nullable": true }, "roleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/DxRoleAssignmentDto" }, "nullable": true }, "tenantPermissions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PermissibleTenantDetailsWithPermissions" }, "nullable": true } }, "additionalProperties": false }, "Notification": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/NotificationType" }, "objectId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "inputData": { "nullable": true }, "outputData": { "nullable": true }, "acknowledgement": { "$ref": "#/components/schemas/NotificationAcknowledgement" }, "acknowledgedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "acknowledgedByUserAzureId": { "type": "string", "nullable": true }, "acknowledgedByUserDisplayName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "adminOnly": { "type": "boolean" }, "onlyForUserId": { "type": "integer", "format": "int32", "nullable": true }, "triggeredByUserId": { "type": "integer", "format": "int32", "nullable": true }, "severity": { "$ref": "#/components/schemas/NotificationSeverity" }, "resolved": { "type": "boolean" } }, "additionalProperties": false }, "NotificationAcknowledgement": { "enum": [ "Unacknowledged", "Acknowledged", "Dismissed" ], "type": "string", "description": "The string or integer value may be used. Unacknowledged = 1, Acknowledged = 2, Dismissed = 3" }, "NotificationSeverity": { "enum": [ "Critical", "Error", "Warning", "Info" ], "type": "string", "description": "The string or integer value may be used. Critical = 1, Error = 2, Warning = 3, Info = 4" }, "NotificationType": { "enum": [ "ProviderHealth", "AccessRequested", "LargeScriptOutput", "UnacknowledgedDeployments", "UpdateInstance", "ProviderAgentsRequiringManualDecision", "AzureTenantProblems", "AzureCustomerPreconsentFailed", "AzureMultiCustomerPreconsentFailed", "ChangeRequestCreatedOrUpdated", "ChangeRequestAcknowledged", "ProviderRecommendation", "FeatureUsageExceeded", "TenantDeletion", "ScheduleFailed" ], "type": "string", "description": "The string or integer value may be used. ProviderHealth = 1, AccessRequested = 2, LargeScriptOutput = 3, UnacknowledgedDeployments = 4, UpdateInstance = 5, ProviderAgentsRequiringManualDecision = 6, AzureTenantProblems = 7, AzureCustomerPreconsentFailed = 8, AzureMultiCustomerPreconsentFailed = 9, ChangeRequestCreatedOrUpdated = 10, ChangeRequestAcknowledged = 11, ProviderRecommendation = 12, FeatureUsageExceeded = 13, TenantDeletion = 14, ScheduleFailed = 15" }, "NuGetVersion": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32", "readOnly": true }, "minor": { "type": "integer", "format": "int32", "readOnly": true }, "patch": { "type": "integer", "format": "int32", "readOnly": true }, "releaseLabels": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "release": { "type": "string", "nullable": true, "readOnly": true }, "isPrerelease": { "type": "boolean", "readOnly": true }, "hasMetadata": { "type": "boolean", "readOnly": true }, "metadata": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true }, "isLegacyVersion": { "type": "boolean", "readOnly": true }, "revision": { "type": "integer", "format": "int32", "readOnly": true }, "isSemVer2": { "type": "boolean", "readOnly": true }, "originalVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ODataErrorDetails": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "requestId": { "type": "string", "nullable": true }, "clientRequestId": { "type": "string", "nullable": true }, "odataType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Oauth2AccessToken": { "required": [ "accessTokenId", "consentData", "tenantPrincipalId", "tokenType" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "consentData": { "$ref": "#/components/schemas/OauthConsentData" }, "allowSilentRefresh": { "type": "boolean" }, "accessTokenId": { "type": "string", "nullable": true }, "tokenType": { "type": "string", "nullable": true }, "accessTokenExpiresAtUtc": { "type": "string", "format": "date-time" }, "tenantPrincipalId": { "type": "string", "nullable": true }, "refreshTokenId": { "type": "string", "nullable": true }, "refreshTokenExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "identityTokenId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Oauth2AccessTokenErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "errorDescription": { "type": "string", "nullable": true }, "errorCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "timestamp": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Oauth2AccessTokenWithTenantNameResponse": { "required": [ "accessTokenId", "consentData", "tenantPrincipalId", "tokenType" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "consentData": { "$ref": "#/components/schemas/OauthConsentData" }, "allowSilentRefresh": { "type": "boolean" }, "accessTokenId": { "type": "string", "nullable": true }, "tokenType": { "type": "string", "nullable": true }, "accessTokenExpiresAtUtc": { "type": "string", "format": "date-time" }, "tenantPrincipalId": { "type": "string", "nullable": true }, "refreshTokenId": { "type": "string", "nullable": true }, "refreshTokenExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "identityTokenId": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "isUsingDefaultClientId": { "type": "boolean" } }, "additionalProperties": false }, "Oauth2AuthCodeErrorResponse": { "required": [ "error", "errorDescription" ], "type": "object", "properties": { "error_description": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "errorDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OauthConsentData": { "type": "object", "properties": { "authorizationEndpoint": { "type": "string", "format": "uri", "nullable": true }, "tokenEndpoint": { "type": "string", "format": "uri", "nullable": true }, "resource": { "type": "string", "nullable": true }, "scopes": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "extraQueryParameters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "usePkce": { "type": "boolean" } }, "additionalProperties": false }, "ObjectOpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "OpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OpResultCircuitBreakerState": { "type": "object", "properties": { "policyName": { "type": "string", "nullable": true }, "circuitState": { "type": "string", "nullable": true }, "lastException": { "$ref": "#/components/schemas/Exception" }, "lastResult": { "$ref": "#/components/schemas/OpResult" }, "lastAttemptedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "OperationType": { "enum": [ "Add", "Remove", "Replace", "Move", "Copy", "Test", "Invalid" ], "type": "string", "description": "The string or integer value may be used. Add = 0, Remove = 1, Replace = 2, Move = 3, Copy = 4, Test = 5, Invalid = 6" }, "OverrideTargetAssignmentRequest": { "required": [ "target" ], "type": "object", "properties": { "targetType": { "$ref": "#/components/schemas/TargetType" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "target": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OwnerAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" } }, "additionalProperties": false }, "PackageType": { "enum": [ "None", "EntireFolder", "InstallerFile" ], "type": "string", "description": "The string or integer value may be used. None = 0, EntireFolder = 1, InstallerFile = 2" }, "Parameter": { "required": [ "name", "parameterType" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "showRawHelpText": { "type": "boolean" }, "onlyForHelpText": { "type": "boolean" }, "defaultValue": { "nullable": true }, "defaultValueText": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "isMandatory": { "type": "boolean" }, "valueFromPipeline": { "type": "boolean" }, "isValueStripped": { "type": "boolean" }, "position": { "type": "integer", "format": "int32" }, "allowNull": { "type": "boolean" }, "parameterType": { "$ref": "#/components/schemas/ParameterType" }, "hasParameterSet": { "type": "boolean" }, "validParamSetValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasDropdownParameterSet": { "type": "boolean" }, "dateOnly": { "type": "boolean" }, "useUtc": { "type": "boolean" }, "validDropdownValues": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterDropdownTextValue" }, "nullable": true }, "showDropdownAsRadioButtons": { "type": "boolean" }, "oauthConsentParameterData": { "$ref": "#/components/schemas/OauthConsentData" } }, "additionalProperties": false }, "ParameterAttributes": { "enum": [ "None", "In", "Out", "Lcid", "Retval", "Optional", "HasDefault", "HasFieldMarshal", "Reserved3", "Reserved4", "ReservedMask" ], "type": "string", "description": "The string or integer value may be used. None = 0, In = 1, Out = 2, Lcid = 4, Retval = 8, Optional = 16, HasDefault = 4096, HasFieldMarshal = 8192, Reserved3 = 16384, Reserved4 = 32768, ReservedMask = 61440" }, "ParameterDropdownTextValue": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "$ref": "#/components/schemas/Type" }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ParameterSet": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "nullable": true } }, "additionalProperties": false }, "ParameterType": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "isEnum": { "type": "boolean" }, "isArray": { "type": "boolean" }, "enumValues": { "nullable": true }, "hasFlagAttribute": { "type": "boolean" }, "elementType": { "nullable": true }, "implementsDictionary": { "type": "boolean" } }, "additionalProperties": false }, "ParameterValue": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false }, "ParentTenantInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PermissibleTenantDetails": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PermissibleTenantDetailsWithPermissions": { "required": [ "grantedPermissionIds", "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "grantedPermissionIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PermissionAssignmentOverview": { "type": "object", "properties": { "permission": { "type": "string", "nullable": true }, "permissionDisplayName": { "type": "string", "nullable": true }, "subjectName": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "permissionName": { "type": "string", "nullable": true }, "isResourceBased": { "type": "boolean" }, "totalAssignments": { "type": "integer", "format": "int32" }, "allowCount": { "type": "integer", "format": "int32" }, "denyCount": { "type": "integer", "format": "int32" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentInfo" }, "nullable": true } }, "additionalProperties": false }, "PermissionCategory": { "enum": [ "View", "CoreCapability", "Advanced" ], "type": "string", "description": "The string or integer value may be used. View = 0, CoreCapability = 1, Advanced = 2" }, "PermissionEvaluationResult": { "type": "object", "properties": { "permission": { "type": "string", "nullable": true }, "permissionDisplayName": { "type": "string", "nullable": true }, "subjectName": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "permissionName": { "type": "string", "nullable": true }, "isResourceBased": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PermissionStatus" }, "isAllow": { "type": "boolean" }, "explanation": { "type": "string", "nullable": true }, "contributingAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ContributingRoleAssignment" }, "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PermissionStatus": { "enum": [ "Allow", "Deny", "NotGranted" ], "type": "string", "description": "The string or integer value may be used. Allow = 0, Deny = 1, NotGranted = 2" }, "Person": { "required": [ "emailAddress" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "azurePrincipalId": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "primaryComputers": { "type": "array", "items": { "$ref": "#/components/schemas/Computer" }, "nullable": true }, "additionalComputers": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerPerson" }, "nullable": true }, "detectedComputerSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftware" }, "nullable": true }, "personSessions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceSession" }, "nullable": true }, "user": { "$ref": "#/components/schemas/User" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "userAffinities": { "type": "array", "items": { "$ref": "#/components/schemas/UserAffinity" }, "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true }, "personTags": { "type": "array", "items": { "$ref": "#/components/schemas/PersonTag" }, "nullable": true }, "onPremisesSecurityIdentifier": { "type": "string", "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "accessRequests": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequest" }, "nullable": true } }, "additionalProperties": false }, "PersonTag": { "type": "object", "properties": { "entityId": { "type": "integer", "format": "int32" }, "tagId": { "type": "integer", "format": "int32" }, "person": { "$ref": "#/components/schemas/Person" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "additionalProperties": false }, "PersonType": { "enum": [ "All", "User", "Person" ], "type": "string", "description": "The string or integer value may be used. All = 0, User = 1, Person = 2" }, "Platform": { "enum": [ "Windows", "Mac", "Linux" ], "type": "string", "description": "The string or integer value may be used. Windows = 1, Mac = 2, Linux = 3" }, "PreconsentCustomerTenantsRequest": { "type": "object", "properties": { "partnerPrincipalId": { "type": "string", "nullable": true }, "customerPrincipalIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PromptTimeoutAction": { "enum": [ "Reboot", "Suppress", "FailSession" ], "type": "string", "description": "The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2" }, "PropertyAttributes": { "enum": [ "None", "SpecialName", "RTSpecialName", "HasDefault", "Reserved2", "Reserved3", "Reserved4", "ReservedMask" ], "type": "string", "description": "The string or integer value may be used. None = 0, SpecialName = 512, RTSpecialName = 1024, HasDefault = 4096, Reserved2 = 8192, Reserved3 = 16384, Reserved4 = 32768, ReservedMask = 62464" }, "PropertyInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "$ref": "#/components/schemas/Type" }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "ProviderAgent": { "required": [ "externalAgentId", "externalClientId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "providerLinkId": { "type": "integer", "format": "int32" }, "externalClientId": { "type": "string", "nullable": true }, "externalAgentId": { "$ref": "#/components/schemas/ExternalAgentId" }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "isOnline": { "type": "boolean" }, "supportsOnlineStatus": { "type": "boolean", "deprecated": true }, "supportsRunningScripts": { "type": "boolean" }, "agentVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "dateAddedUTC": { "type": "string", "format": "date-time" }, "lastUpdatedUTC": { "type": "string", "format": "date-time" }, "internalData": { "nullable": true }, "deviceDetails": { "$ref": "#/components/schemas/DeviceDetails" }, "onboardingOptions": { "$ref": "#/components/schemas/AgentOnboardingOptions" }, "requireManualIdentification": { "type": "boolean" }, "providerLink": { "$ref": "#/components/schemas/ProviderLink" }, "computer": { "$ref": "#/components/schemas/Computer" }, "providerClient": { "$ref": "#/components/schemas/ProviderClient" }, "identificationFailures": { "type": "array", "items": { "$ref": "#/components/schemas/AgentIdentificationFailure" }, "nullable": true, "readOnly": true }, "identificationLogs": { "type": "array", "items": { "$ref": "#/components/schemas/AgentIdentificationLog" }, "nullable": true, "readOnly": true }, "isMemberOfInitialDeviceSync": { "type": "boolean" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedReason": { "type": "string", "nullable": true }, "compositeKey": { "$ref": "#/components/schemas/ProviderAgentCompositeKey" } }, "additionalProperties": false }, "ProviderAgentCompositeKey": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "externalAgentId": { "$ref": "#/components/schemas/ExternalAgentId" } }, "additionalProperties": false }, "ProviderAgentFilter": { "enum": [ "All", "OnlyPendingIdentification", "OnlyIdentified", "RequiresManualDecision", "AssociatedToDeletedComputers" ], "type": "string", "description": "The string or integer value may be used. All = 1, OnlyPendingIdentification = 2, OnlyIdentified = 3, RequiresManualDecision = 4, AssociatedToDeletedComputers = 5" }, "ProviderClient": { "required": [ "externalClientId", "externalClientName" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32" }, "externalClientId": { "type": "string", "nullable": true }, "externalClientName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "internalData": { "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "providerLink": { "$ref": "#/components/schemas/ProviderLink" }, "hasCompletedInitialAgentSync": { "type": "boolean" }, "types": { "type": "array", "items": { "type": "string" }, "nullable": true }, "providerAgents": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderAgent" }, "nullable": true } }, "additionalProperties": false }, "ProviderClientLinkToTenantByExactNameResponse": { "required": [ "externalClientId" ], "type": "object", "properties": { "externalClientId": { "type": "string", "nullable": true }, "linkedToTenantId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProviderLink": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "disabled": { "type": "boolean" }, "disabledOrUnhealthy": { "type": "boolean", "readOnly": true }, "healthStatus": { "$ref": "#/components/schemas/HealthStatus" }, "healthStatusMessage": { "type": "string", "nullable": true }, "unhealthyCount": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "runScriptPriority": { "type": "integer", "format": "int32" }, "providerTypeFormData": { }, "providerTypeId": { "type": "string", "format": "uuid" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "providerClients": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderClient" }, "nullable": true }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" }, "nullable": true }, "targetAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignment" }, "nullable": true }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderAgent" }, "nullable": true }, "providersLinkedFromThisProvider": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLinkCrossReference" }, "nullable": true }, "linkedFromProviders": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLinkCrossReference" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "excludedCapabilities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "providerInternalData": { "$ref": "#/components/schemas/ProviderLinkInternalData" } }, "additionalProperties": false }, "ProviderLinkCrossReference": { "type": "object", "properties": { "isExternalClientLinkingEnabled": { "type": "boolean" }, "isProviderLink2InitializedFromProviderLink1": { "type": "boolean" }, "providerLink1Id": { "type": "integer", "format": "int32" }, "providerLink2Id": { "type": "integer", "format": "int32" }, "providerLink1": { "$ref": "#/components/schemas/ProviderLink" }, "providerLink2": { "$ref": "#/components/schemas/ProviderLink" } }, "additionalProperties": false }, "ProviderLinkExternalReferenceDataBody": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "providerTypeFormData": { }, "enableClientExternalLinking": { "type": "boolean" } }, "additionalProperties": false }, "ProviderLinkInternalData": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "internalData": { "nullable": true }, "providerLink": { "$ref": "#/components/schemas/ProviderLink" } }, "additionalProperties": false }, "ProviderLinkUpdate": { "type": "object", "properties": { "providerLinkId": { "type": "integer", "format": "int32" }, "clientId": { "type": "string", "nullable": true }, "deviceUpdateFormData": { "nullable": true } }, "additionalProperties": false }, "ProviderTypeDto": { "type": "object", "properties": { "providerTypeId": { "type": "string", "format": "uuid" }, "source": { "$ref": "#/components/schemas/ProviderTypeSource" }, "isDynamic": { "type": "boolean" }, "tag": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "configurationForm": { "$ref": "#/components/schemas/DynamicFormBindResultWithConvertedParameters" }, "logoSrc": { "type": "string", "nullable": true }, "docsUrl": { "type": "string", "nullable": true }, "screenShareLogoSrc": { "type": "string", "nullable": true }, "canManage": { "type": "boolean" }, "deviceGroupTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceGroupTypeDto" }, "nullable": true }, "clientGroupTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ClientGroupTypeDto" }, "nullable": true }, "supportsDeviceUpdating": { "type": "boolean" }, "providerCapabilities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "agentUpdateFormSchema": { "$ref": "#/components/schemas/AgentUpdateFormSchema" }, "supportedCrossProviderClientLinkages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedCrossProviderLinkage" }, "nullable": true }, "supportedCrossProviderInitializationLinkages": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedCrossProviderLinkage" }, "nullable": true } }, "additionalProperties": false }, "ProviderTypeSource": { "enum": [ "BuiltIn", "Local", "Global" ], "type": "string", "description": "The string or integer value may be used. BuiltIn = 1, Local = 2, Global = 3" }, "ProvisioningPackageOptions": { "type": "object", "properties": { "encryptPackage": { "type": "boolean" }, "packagePassword": { "type": "string", "nullable": true }, "downloadISO": { "type": "boolean" }, "wirelessOpen": { "type": "boolean", "nullable": true }, "wirelessSSID": { "type": "string", "nullable": true }, "wirelessKey": { "type": "string", "nullable": true }, "setupAdmin": { "type": "boolean" }, "localAdminUsername": { "type": "string", "nullable": true }, "localAdminPassword": { "type": "string", "nullable": true }, "hideAdminAccount": { "type": "boolean" }, "enableCleanPC": { "type": "boolean" }, "disableHibernation": { "type": "boolean" }, "setupWireless": { "type": "boolean" } }, "additionalProperties": false }, "RebootPreference": { "enum": [ "Normal", "Suppress", "Prompt", "Force" ], "type": "string", "description": "The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1" }, "RecommendedTargetAssignmentApproval": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "globalTargetAssignmentId": { "type": "integer", "format": "int32" }, "approved": { "type": "boolean" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "RegistryKeyDto": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "fullPath": { "type": "string", "nullable": true }, "subKeyCount": { "type": "integer", "format": "int32" }, "valueCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RegistryKeyDtoArrayOpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryKeyDto" }, "nullable": true } }, "additionalProperties": false }, "RegistryPayload": { "type": "object", "properties": { "keyPath": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistryValueDto": { "required": [ "kind", "parentKeyPath", "valueName" ], "type": "object", "properties": { "binaryValue": { "type": "string", "nullable": true }, "dWordValue": { "type": "integer", "format": "int32", "nullable": true }, "kind": { "$ref": "#/components/schemas/RegistryValueKindDto" }, "multiStringValue": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parentKeyPath": { "type": "string", "nullable": true }, "qWordValue": { "type": "integer", "format": "int64", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "valueName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistryValueDtoArrayOpResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryValueDto" }, "nullable": true } }, "additionalProperties": false }, "RegistryValueKindDto": { "enum": [ "Unknown", "String", "ExpandString", "Binary", "DWord", "MultiString", "QWord", "None" ], "type": "string", "description": "The string or integer value may be used. Unknown = 0, String = 1, ExpandString = 2, Binary = 3, DWord = 4, MultiString = 7, QWord = 11, None = -1" }, "Relationship": { "enum": [ "Owned", "Assigned" ], "type": "string", "description": "The string or integer value may be used. Owned = 0, Assigned = 1" }, "ReleaseChannel": { "enum": [ "Developer", "Alpha", "Beta", "General" ], "type": "string", "description": "The string or integer value may be used. Developer = 1, Alpha = 2, Beta = 3, General = 4" }, "ReleaseDetails": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/SemanticVersion" }, "releaseNotes": { "type": "string", "nullable": true }, "releaseChannel": { "$ref": "#/components/schemas/ReleaseChannel" }, "immyAgentInstallerVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "immyAgentInstallerFileVersion": { "type": "string", "nullable": true }, "publishedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RemoteControlRecording": { "required": [ "blobName", "mimeContentType" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "mimeContentType": { "type": "string", "nullable": true }, "blobName": { "type": "string", "nullable": true }, "computer": { "$ref": "#/components/schemas/Computer" }, "computerId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "tenantId": { "type": "integer", "format": "int32" }, "user": { "$ref": "#/components/schemas/User" }, "userId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RemoveParentTenantRequest": { "type": "object", "properties": { "tenantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RemoveTagsRequest": { "type": "object", "properties": { "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "RepairActionType": { "enum": [ "None", "UninstallInstall", "InstallOver", "CustomScript" ], "type": "string", "description": "The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, CustomScript = 3" }, "RequestFormSupportBody": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "requesterEmail": { "type": "string", "nullable": true }, "allowTechnicianAccess": { "type": "boolean", "nullable": true }, "blobNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RequestSessionSupportRequestBody": { "type": "object", "properties": { "sessionId": { "type": "integer", "format": "int32" }, "ticketSubject": { "type": "string", "nullable": true }, "ticketNotes": { "type": "string", "nullable": true }, "allowTechnicianAccess": { "type": "boolean", "nullable": true }, "includeSessionData": { "type": "boolean" } }, "additionalProperties": false }, "RerunSessionsRequestBody": { "type": "object", "properties": { "sessionIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "ResolveAssignmentsForMaintenanceItemRequest": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" } }, "additionalProperties": false }, "ResolveAssignmentsForMaintenanceItemResult": { "type": "object", "properties": { "computers": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDto" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolveAssignmentsForMaintenanceItemResultItem" }, "nullable": true } }, "additionalProperties": false }, "ResolveAssignmentsForMaintenanceItemResultItem": { "type": "object", "properties": { "deploymentId": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "deploymentPhrase": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResolveFailuresRequestBody": { "type": "object", "properties": { "agentIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "allAgents": { "type": "boolean" } }, "additionalProperties": false }, "ResolveOnboardingOverridableAssignmentsResponseBody": { "type": "object", "properties": { "overridableAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" }, "nullable": true }, "nextHighestPriorityNonOnboardingOnlyAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentResource" }, "nullable": true } }, "additionalProperties": false }, "ResolveVisibilityTargetAssignmentsRequest": { "type": "object", "properties": { "personId": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "visibility": { "$ref": "#/components/schemas/TargetVisibility" } }, "additionalProperties": false, "description": "Resolves assignments for a technician pod target against a person and/or tenant and/or computer." }, "Role": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "normalizedName": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "roleTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "tenantRestrictionMode": { "$ref": "#/components/schemas/TenantRestrictionMode" }, "roleType": { "$ref": "#/components/schemas/RoleType" }, "userRoles": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" }, "nullable": true, "deprecated": true }, "roleClaims": { "type": "array", "items": { "$ref": "#/components/schemas/RoleClaim" }, "nullable": true }, "userRoleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignment" }, "nullable": true }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "customAuditProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AuditPropertyChange" }, "nullable": true, "readOnly": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" } }, "additionalProperties": false }, "RoleAssignmentInfo": { "required": [ "assignment" ], "type": "object", "properties": { "roleName": { "type": "string", "nullable": true }, "isBuiltIn": { "type": "boolean" }, "precedenceLevel": { "type": "integer", "format": "int32" }, "assignment": { "$ref": "#/components/schemas/UserRoleAssignmentDto" } }, "additionalProperties": false }, "RoleClaim": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "claimType": { "type": "string", "nullable": true }, "claimValue": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/Role" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "auditObjectName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RoleType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RunAdHocMetascriptRequestBody": { "required": [ "scriptBody" ], "type": "object", "properties": { "scriptName": { "type": "string", "nullable": true }, "scriptBody": { "type": "string", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "invalidateFunctionScriptCache": { "type": "boolean" }, "terminalId": { "type": "string", "format": "uuid", "nullable": true }, "cancellationId": { "type": "string", "format": "uuid", "nullable": true }, "scriptExecutionTimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true }, "agentConnectionWaitTimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RunImmyServiceRequestBody": { "type": "object", "properties": { "computers": { "type": "array", "items": { "$ref": "#/components/schemas/RunImmybotComputerRequestBody" }, "nullable": true }, "tenants": { "type": "array", "items": { "$ref": "#/components/schemas/RunImmybotTenantRequestBody" }, "nullable": true }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/RunImmybotPersonRequestBody" }, "nullable": true }, "maintenanceParams": { "$ref": "#/components/schemas/RunImmybotMaintenanceRequestBody" }, "skipBackgroundJob": { "type": "boolean", "description": "If true then hangfire is not used" }, "cacheOnly": { "type": "boolean" }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "updateTime": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" }, "fullMaintenance": { "type": "boolean" }, "detectionOnly": { "type": "boolean" }, "resolutionOnly": { "type": "boolean" }, "inventoryOnly": { "type": "boolean" }, "runInventoryInDetection": { "type": "boolean" }, "deploymentId": { "type": "integer", "format": "int32", "nullable": true }, "deploymentType": { "$ref": "#/components/schemas/DatabaseType" }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" }, "useWinningDeployment": { "type": "boolean" }, "sessionGroupId": { "type": "string", "format": "uuid", "nullable": true }, "providerLinkIdForAgentUpdates": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" } }, "additionalProperties": false }, "RunImmyServiceResponseBody": { "type": "object", "properties": { "sessionsStarted": { "type": "array", "items": { "$ref": "#/components/schemas/RunImmyServiceResponseSession" }, "nullable": true, "readOnly": true }, "sessionsAlreadyInProgress": { "type": "array", "items": { "$ref": "#/components/schemas/RunImmyServiceResponseSession" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RunImmyServiceResponseSession": { "type": "object", "properties": { "personId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "sessionId": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "RunImmybotComputerRequestBody": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "maintenanceTaskParameterValueOverrides": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RunImmybotMaintenanceRequestBody": { "type": "object", "properties": { "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "repair": { "type": "boolean" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "semanticVersionNormalized": { "type": "string", "nullable": true, "readOnly": true }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" } }, "additionalProperties": false }, "RunImmybotPersonRequestBody": { "type": "object", "properties": { "personId": { "type": "integer", "format": "int32" }, "maintenanceTaskParameterValueOverrides": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RunImmybotTenantRequestBody": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "maintenanceTaskParameterValueOverrides": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RunScriptRequestBody": { "required": [ "script" ], "type": "object", "properties": { "script": { "$ref": "#/components/schemas/RunScriptRequestBodyScript" }, "cancellationId": { "type": "string", "format": "uuid" }, "terminalId": { "type": "string", "format": "uuid", "nullable": true }, "maintenanceSessionId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true }, "sessionLogId": { "type": "integer", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "agentConnectionWaitTimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RunScriptRequestBodyScript": { "required": [ "action", "databaseType", "filterScriptMode", "id", "name", "outputType", "parameterOverrides", "scriptCategory", "scriptExecutionContext", "scriptLanguage", "variables" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "parameterOverrides": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "variables": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RuntimeFieldHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeTypeHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "Schedule": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" }, "day": { "type": "integer", "format": "int32", "nullable": true }, "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "applyWindowsUpdates": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" }, "allowAccessToMSPResources": { "type": "boolean" }, "timeZoneInfoId": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "maintenanceTime": { "type": "string", "nullable": true }, "customCronExpression": { "type": "string", "nullable": true }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "providerLink": { "$ref": "#/components/schemas/ProviderLink" } }, "additionalProperties": false }, "Script": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "action": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "readOnly": { "type": "boolean" }, "identifier": { "type": "string", "nullable": true, "readOnly": true }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "publicStorageDownloadUrl": { "type": "string", "nullable": true }, "scriptHash": { "type": "string", "nullable": true }, "scriptCacheName": { "type": "string", "nullable": true }, "variables": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "parameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "parameterOverrides": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "dynamicProviderStoreId": { "type": "string", "nullable": true }, "dynamicIntegrationTypeProperties": { "$ref": "#/components/schemas/DynamicIntegrationTypeProperties" }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "tenantRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/TenantScript" }, "nullable": true, "deprecated": true }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "hidden": { "type": "boolean", "deprecated": true }, "errorActionPreference": { "$ref": "#/components/schemas/ActionPreference" }, "skipPreflight": { "type": "boolean" }, "skipBusinessHoursCheck": { "type": "boolean" }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "dynamicIntegrationType": { "$ref": "#/components/schemas/DynamicIntegrationType" }, "inventoryTaskScript": { "$ref": "#/components/schemas/InventoryTaskScript" }, "authorizedViewers": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptViewer" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" } }, "additionalProperties": false }, "ScriptActionAudit": { "type": "object", "properties": { "newValue": { "type": "string", "description": "", "nullable": true }, "oldValue": { "type": "string", "description": "", "nullable": true }, "dateTimeUtc": { "type": "string", "description": "", "format": "date-time" }, "userDisplayName": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false, "description": "Audit details for a script object." }, "ScriptActionAuditResult": { "type": "object", "properties": { "total": { "type": "integer", "description": "", "format": "int32" }, "audit": { "$ref": "#/components/schemas/ScriptActionAudit" } }, "additionalProperties": false, "description": "Response indicating the total number of audits for a given script object and the audit details requested." }, "ScriptCategory": { "enum": [ "SoftwareDetection", "SoftwareVersionAction", "MaintenanceTaskSetter", "MetascriptDeploymentTarget", "FilterScriptDeploymentTarget", "DeviceInventory", "Function", "ImmySystem", "DynamicVersions", "DownloadInstaller", "Module", "Preflight", "Integration" ], "type": "string", "description": "The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13" }, "ScriptExecutionContext": { "enum": [ "System", "CurrentUser", "Metascript", "CloudScript" ], "type": "string", "description": "The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4" }, "ScriptLanguage": { "enum": [ "CommandLine", "PowerShell" ], "type": "string", "description": "The string or integer value may be used. CommandLine = 1, PowerShell = 2" }, "ScriptOutputType": { "enum": [ "Object", "Table" ], "type": "string", "description": "The string or integer value may be used. Object = 0, Table = 1" }, "ScriptReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptReferenceType": { "$ref": "#/components/schemas/ScriptReferenceType" }, "softwareVersion": { "$ref": "#/components/schemas/SemanticVersion" } }, "additionalProperties": false }, "ScriptReferenceCounts": { "type": "object", "properties": { "localSoftwareCount": { "type": "integer", "format": "int32" }, "localSoftwareVersionCount": { "type": "integer", "format": "int32" }, "localMaintenanceTaskCount": { "type": "integer", "format": "int32" }, "globalSoftwareCount": { "type": "integer", "format": "int32" }, "globalSoftwareVersionCount": { "type": "integer", "format": "int32" }, "globalMaintenanceTaskCount": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ScriptReferenceType": { "enum": [ "Software", "SoftwareVersion", "MaintenanceTask" ], "type": "string", "description": "The string or integer value may be used. Software = 1, SoftwareVersion = 2, MaintenanceTask = 3" }, "ScriptSearchResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "action": { "type": "string", "nullable": true, "readOnly": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" } }, "additionalProperties": false }, "ScriptSyntaxCheckRequestBody": { "required": [ "script" ], "type": "object", "properties": { "script": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" } }, "additionalProperties": false }, "ScriptViewer": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "scriptId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "SecurityRuleSet": { "enum": [ "None", "Level1", "Level2" ], "type": "string", "description": "The string or integer value may be used. None = 0, Level1 = 1, Level2 = 2" }, "SemanticVersion": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32", "readOnly": true }, "minor": { "type": "integer", "format": "int32", "readOnly": true }, "patch": { "type": "integer", "format": "int32", "readOnly": true }, "releaseLabels": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "release": { "type": "string", "nullable": true, "readOnly": true }, "isPrerelease": { "type": "boolean", "readOnly": true }, "hasMetadata": { "type": "boolean", "readOnly": true }, "metadata": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SendTestBrandingEmailRequest": { "required": [ "branding", "to" ], "type": "object", "properties": { "to": { "type": "string", "nullable": true }, "branding": { "$ref": "#/components/schemas/CreateBrandingRequestBody" } }, "additionalProperties": false }, "SendTestEmailRequest": { "required": [ "from", "host", "password", "to" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "host": { "type": "string", "nullable": true }, "enableSSL": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "to": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SessionJobArgs": { "type": "object", "properties": { "sessionGroupId": { "type": "string", "format": "uuid", "nullable": true }, "manuallyTriggeredByUserId": { "type": "integer", "format": "int32", "nullable": true }, "manuallyResumedByPersonId": { "type": "integer", "format": "int32", "nullable": true }, "manuallyResumed": { "type": "boolean" }, "scheduledId": { "type": "integer", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "installWindowsUpdates": { "type": "boolean" }, "cacheOnly": { "type": "boolean" }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "maintenanceSchedulingConfiguration": { "$ref": "#/components/schemas/MaintenanceSchedulingConfiguration" }, "maintenanceOnboardingConfiguration": { "$ref": "#/components/schemas/MaintenanceOnboardingConfiguration" }, "maintenanceEmailConfiguration": { "$ref": "#/components/schemas/MaintenanceEmailConfiguration" }, "maintenanceAgentUpdatesConfiguration": { "$ref": "#/components/schemas/MaintenanceAgentUpdatesConfiguration" }, "maintenanceItem": { "$ref": "#/components/schemas/MaintenanceItem" }, "deploymentId": { "type": "integer", "format": "int32", "nullable": true }, "deploymentType": { "$ref": "#/components/schemas/DatabaseType" }, "cacheGroupId": { "type": "string", "format": "uuid", "nullable": true }, "rerunningAction": { "type": "boolean" }, "actionIdToRerun": { "type": "integer", "format": "int32", "nullable": true }, "terminalId": { "type": "string", "format": "uuid", "nullable": true }, "detectionOnly": { "type": "boolean" }, "runInventoryInDetection": { "type": "boolean" }, "resolutionOnly": { "type": "boolean" }, "inventoryOnly": { "type": "boolean" }, "repair": { "type": "boolean" }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "appliedOnConnect": { "type": "boolean" }, "useWinningDeployment": { "type": "boolean" }, "hasSessionFeatureBeenTracked": { "type": "boolean" }, "rerunFromScheduleId": { "type": "integer", "format": "int32", "nullable": true }, "enqueuedSessionType": { "$ref": "#/components/schemas/EnqueuedSessionType" } }, "additionalProperties": false }, "SessionLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "maintenanceSessionStageId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true }, "sessionPhaseId": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceActionStatus": { "$ref": "#/components/schemas/MaintenanceActionStatus" }, "sessionLogType": { "$ref": "#/components/schemas/SessionLogType" }, "message": { "type": "string", "nullable": true }, "progressCorrelationId": { "type": "string", "format": "uuid", "nullable": true }, "progressPercentComplete": { "type": "number", "format": "double", "nullable": true }, "progressActivity": { "type": "string", "nullable": true }, "progressStatus": { "type": "string", "nullable": true }, "progressSecondsRemaining": { "type": "number", "format": "double", "nullable": true }, "progressCurrentOperation": { "type": "string", "nullable": true }, "progressCompleted": { "type": "boolean" }, "time": { "type": "string", "format": "date-time" }, "updatedTime": { "type": "string", "format": "date-time", "nullable": true }, "scriptId": { "type": "integer", "format": "int32", "nullable": true }, "script": { "type": "string", "nullable": true }, "scriptOutput": { "type": "string", "nullable": true }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "immediateUser": { "type": "boolean", "nullable": true }, "scriptParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "paramBlockParameters": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "scriptTimeout": { "type": "integer", "format": "int32", "nullable": true }, "isPrimary": { "type": "boolean" }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" }, "maintenanceSessionStage": { "$ref": "#/components/schemas/MaintenanceSessionStage" }, "maintenanceAction": { "$ref": "#/components/schemas/MaintenanceAction" }, "sessionPhase": { "$ref": "#/components/schemas/SessionPhase" } }, "additionalProperties": false }, "SessionLogType": { "enum": [ "Generic", "Error", "Command", "CommandResult", "Progress" ], "type": "string", "description": "The string or integer value may be used. Generic = 0, Error = 1, Command = 2, CommandResult = 3, Progress = 4" }, "SessionPhase": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "phaseName": { "type": "string", "nullable": true }, "actionProgressPhaseName": { "$ref": "#/components/schemas/ActionProgressPhaseName" }, "maintenanceSessionId": { "type": "integer", "format": "int32" }, "maintenanceSessionStageId": { "type": "integer", "format": "int32" }, "maintenanceActionId": { "type": "integer", "format": "int32", "nullable": true }, "status": { "$ref": "#/components/schemas/SessionPhaseStatus" }, "progressPercentComplete": { "type": "number", "format": "double", "nullable": true }, "progressStatus": { "type": "string", "nullable": true }, "progressCompleted": { "type": "boolean" }, "maintenanceSession": { "$ref": "#/components/schemas/MaintenanceSession" }, "maintenanceSessionStage": { "$ref": "#/components/schemas/MaintenanceSessionStage" }, "maintenanceAction": { "$ref": "#/components/schemas/MaintenanceAction" }, "dateStartedUtc": { "type": "string", "format": "date-time", "nullable": true }, "dateCompletedUtc": { "type": "string", "format": "date-time", "nullable": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SessionLog" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SessionPhaseStatus": { "enum": [ "Unstarted", "Skipped", "Running", "Succeeded", "Failed" ], "type": "string", "description": "The string or integer value may be used. Unstarted = 0, Skipped = 1, Running = 2, Succeeded = 3, Failed = 4" }, "SessionStageType": { "enum": [ "Onboarding", "Detection", "Execution", "AgentUpdates", "Resolution", "Inventory" ], "type": "string", "description": "The string or integer value may be used. Onboarding = 0, Detection = 1, Execution = 2, AgentUpdates = 3, Resolution = 4, Inventory = 5" }, "SessionStatus": { "enum": [ "Passed", "Running", "Failed", "Created", "Cancelled", "Postponed", "Pending", "PartialPassed", "PendingConnectivity", "Missed", "MaxTrackedDevicesPerMonthExceeded", "PendingPreflight", "PendingEphemeralAgentConnection", "MaintenanceForTrackableDevicesNotAllowed" ], "type": "string", "description": "The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13" }, "SessionType": { "enum": [ "Cloud", "Computer", "Person" ], "type": "string", "description": "The string or integer value may be used. Cloud = 1, Computer = 2, Person = 3" }, "SetExcludedFromUserAffinityRequestBody": { "type": "object", "properties": { "isExcluded": { "type": "boolean" } }, "additionalProperties": false }, "SetParentTenantRequest": { "type": "object", "properties": { "tenantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SetPreflightScriptEnablementRequest": { "type": "object", "properties": { "scriptId": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "SetupTestIntegrationRequest": { "type": "object", "properties": { "script": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShowCommandInfo": { "type": "object", "properties": { "definition": { "type": "string", "nullable": true }, "parameterSets": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterSet" }, "nullable": true } }, "additionalProperties": false }, "SkipOnboardingRequest": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SkipOnboardingResponse": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmtpConfig": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "host": { "type": "string", "nullable": true }, "enableSSL": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "passwordHash": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "useAuthentication": { "type": "boolean" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" } }, "additionalProperties": false }, "SoftwareFileUploadData": { "type": "object", "properties": { "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerFile": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "format": "uuid" }, "fileBlobName": { "type": "string", "nullable": true }, "md5Hash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SoftwareLicenseRequirement": { "enum": [ "None", "Required", "Optional" ], "type": "string", "description": "The string or integer value may be used. None = 0, Required = 1, Optional = 2" }, "SoftwarePrerequisite": { "type": "object", "properties": { "softwaresForCondition": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareSpecifier" }, "nullable": true, "readOnly": true }, "softwaresToPerformActionOn": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareSpecifier" }, "nullable": true, "readOnly": true }, "subjectQualifier": { "$ref": "#/components/schemas/SubjectQualifier" }, "condition": { "$ref": "#/components/schemas/Condition" }, "actionToPerform": { "$ref": "#/components/schemas/ActionToPerform" }, "softwareSpecifiers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SoftwareSpecifier" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SoftwareProviderType": { "enum": [ "Ninite", "Chocolatey", "Inherent" ], "type": "string", "description": "The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3" }, "SoftwareRegistryContext": { "enum": [ "Machine", "User", "System" ], "type": "string", "description": "The string or integer value may be used. Machine = 0, User = 1, System = 2" }, "SoftwareSpecifier": { "type": "object", "properties": { "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true }, "maintenanceSpecifier": { "$ref": "#/components/schemas/MaintenanceSpecifier" } }, "additionalProperties": false }, "SoftwareTableNameSearchMode": { "enum": [ "Contains", "Regex", "Traditional" ], "type": "string", "description": "The string or integer value may be used. Contains = 0, Regex = 1, Traditional = 2" }, "SoftwareType": { "enum": [ "GlobalSoftware", "LocalSoftware", "WindowsUpdate", "Chocolatey", "Ninite" ], "type": "string", "description": "The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4" }, "SoftwareVersionInstallerType": { "enum": [ "None", "File", "Url" ], "type": "string", "description": "The string or integer value may be used. None = 0, File = 1, Url = 2" }, "SortingInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "desc": { "type": "boolean" } }, "additionalProperties": false }, "SourceContextLogLevel": { "type": "object", "properties": { "sourceContext": { "type": "string", "nullable": true }, "logLevel": { "$ref": "#/components/schemas/LogLevel" } }, "additionalProperties": false }, "SpecificResourceAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "resourceId": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpecificTenantAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "tenantId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StartEditorServicesRequest": { "type": "object", "properties": { "terminalId": { "type": "string", "format": "uuid" }, "scriptId": { "type": "integer", "format": "int32", "nullable": true }, "scriptType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" } }, "additionalProperties": false }, "StructLayoutAttribute": { "type": "object", "properties": { "typeId": { "nullable": true, "readOnly": true }, "value": { "$ref": "#/components/schemas/LayoutKind" } }, "additionalProperties": false }, "SubjectQualifier": { "enum": [ "AnyOf", "AllOf" ], "type": "string", "description": "The string or integer value may be used. AnyOf = 0, AllOf = 1" }, "SubmitFeedbackRequestBody": { "required": [ "details", "rating" ], "type": "object", "properties": { "details": { "type": "string", "nullable": true }, "rating": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionAddonDto": { "type": "object", "properties": { "addonId": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "price": { "type": "integer", "format": "int32", "nullable": true }, "trialEndUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SubscriptionFeatureBasicInfo": { "type": "object", "properties": { "featureId": { "type": "string", "nullable": true }, "featureName": { "type": "string", "nullable": true }, "featureDescription": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SubscriptionFeatureStatus" }, "type": { "$ref": "#/components/schemas/SubscriptionFeatureType" }, "unit": { "type": "string", "nullable": true }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionFeatureLevelInfo" } } }, "additionalProperties": false }, "SubscriptionFeatureLevelInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "level": { "type": "integer", "format": "int32" }, "isUnlimited": { "type": "boolean" } }, "additionalProperties": false }, "SubscriptionFeatureStatus": { "enum": [ "UnKnown", "Active", "Archived", "Draft" ], "type": "string", "description": "The string or integer value may be used. UnKnown = 0, Active = 1, Archived = 2, Draft = 3" }, "SubscriptionFeatureType": { "enum": [ "UnKnown", "Switch", "Custom", "Quantity", "Range" ], "type": "string", "description": "The string or integer value may be used. UnKnown = 0, Switch = 1, Custom = 2, Quantity = 3, Range = 4" }, "SubscriptionItemBasicInfo": { "type": "object", "properties": { "itemId": { "type": "string", "nullable": true }, "itemName": { "type": "string", "nullable": true }, "itemDescription": { "type": "string", "nullable": true }, "itemType": { "$ref": "#/components/schemas/SubscriptionItemType" } }, "additionalProperties": false }, "SubscriptionItemType": { "enum": [ "UnKnown", "Plan", "Addon", "Charge" ], "type": "string", "description": "The string or integer value may be used. UnKnown = 0, Plan = 1, Addon = 2, Charge = 3" }, "SubscriptionStatus": { "enum": [ "InTrial", "Active", "Inactive" ], "type": "string", "description": "The string or integer value may be used. InTrial = 0, Active = 1, Inactive = 2" }, "SummaryInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "summaryType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SupportedCrossProviderLinkage": { "type": "object", "properties": { "providerTypeId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SyncAgentsForClientsRequest": { "type": "object", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SyncAzureDataForTenantsRequest": { "type": "object", "properties": { "tenantPrincipalIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allPartnerTenants": { "type": "boolean" } }, "additionalProperties": false }, "SyntaxCheckerResult": { "type": "object", "properties": { "isSyntaxValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Tag": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "computers": { "type": "array", "items": { "$ref": "#/components/schemas/Computer" }, "nullable": true }, "computerTags": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerTag" }, "nullable": true }, "tenantTags": { "type": "array", "items": { "$ref": "#/components/schemas/TenantTag" }, "nullable": true }, "tenants": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" }, "nullable": true }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "nullable": true }, "personTags": { "type": "array", "items": { "$ref": "#/components/schemas/PersonTag" }, "nullable": true }, "tenantRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/TenantTagAuthorization" }, "nullable": true, "deprecated": true }, "tenantId": { "type": "integer", "format": "int32" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "authorizedViewers": { "type": "array", "items": { "$ref": "#/components/schemas/TagViewer" }, "nullable": true }, "visibleToAllTenants": { "type": "boolean" } }, "additionalProperties": false }, "TagResourceAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "tagId": { "type": "integer", "format": "int32" }, "tagName": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TagViewer": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "tagId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "additionalProperties": false }, "TargetAssignment": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "isCore": { "type": "boolean" }, "autoApprove": { "type": "boolean" }, "integrationTypeId": { "type": "string", "nullable": true }, "integrationPrompt": { "type": "string", "nullable": true }, "excluded": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "onboardingOnly": { "type": "boolean", "deprecated": true }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "target": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "providerLink": { "$ref": "#/components/schemas/ProviderLink" }, "notes": { "$ref": "#/components/schemas/TargetAssignmentNotes" }, "visibility": { "$ref": "#/components/schemas/TargetAssignmentVisibility" }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareSemanticVersionString": { "type": "string", "nullable": true, "readOnly": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "license": { "$ref": "#/components/schemas/License" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "maintenanceTaskParameterValues": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterValue" }, "nullable": true, "deprecated": true }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" }, "nullable": true }, "parameterValueMigrationErrors": { "type": "string", "nullable": true }, "softwareSpecifier": { "$ref": "#/components/schemas/SoftwareSpecifier" }, "maintenanceSpecifier": { "$ref": "#/components/schemas/MaintenanceSpecifier" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "softwareId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "softwareVersionId": { "type": "integer", "format": "int32", "deprecated": true } }, "additionalProperties": false }, "TargetAssignmentApprovalStatus": { "enum": [ "Pending", "Approved", "Denied" ], "type": "string", "description": "The string or integer value may be used. Pending = 1, Approved = 2, Denied = 3" }, "TargetAssignmentDuplicateResponse": { "type": "object", "properties": { "duplicateIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "count": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "TargetAssignmentNotes": { "required": [ "notes", "targetAssignmentId", "updatedByName" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "targetAssignmentId": { "type": "integer", "format": "int32" }, "updatedByName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "targetAssignment": { "$ref": "#/components/schemas/TargetAssignment" } }, "additionalProperties": false }, "TargetAssignmentResource": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "targetText": { "type": "string", "nullable": true }, "targetTypeName": { "type": "string", "nullable": true }, "targetScopeName": { "type": "string", "nullable": true }, "targetMissing": { "type": "boolean" }, "tenantMissing": { "type": "boolean" }, "targetTypeMissing": { "type": "boolean" }, "targetTypeDescription": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "onboardingOnly": { "type": "boolean" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "targetGroupFilterName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "isCore": { "type": "boolean" }, "excluded": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "notes": { "type": "string", "nullable": true }, "notesUpdatedByUserName": { "type": "string", "nullable": true }, "notesUpdatedUtc": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "targetName": { "type": "string", "nullable": true }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareSemanticVersionString": { "type": "string", "nullable": true }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "licenseName": { "type": "string", "nullable": true }, "updatedDateUTC": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "createdDateUTC": { "type": "string", "format": "date-time" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "integrationTypeId": { "type": "string", "nullable": true }, "integrationPrompt": { "type": "string", "nullable": true }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetVisibility": { "$ref": "#/components/schemas/TargetAssignmentVisibilityResource" } }, "additionalProperties": false }, "TargetAssignmentVisibility": { "type": "object", "properties": { "targetAssignmentId": { "type": "integer", "format": "int32" }, "targetAssignment": { "$ref": "#/components/schemas/TargetAssignment" }, "selfService": { "type": "boolean" }, "technicianPod": { "type": "boolean" } }, "additionalProperties": false }, "TargetAssignmentVisibilityPayload": { "type": "object", "properties": { "selfService": { "type": "boolean" }, "technicianPod": { "type": "boolean" } }, "additionalProperties": false }, "TargetAssignmentVisibilityResource": { "type": "object", "properties": { "selfService": { "type": "boolean" }, "technicianPod": { "type": "boolean" } }, "additionalProperties": false }, "TargetCategory": { "enum": [ "Computer", "Tenant", "Person" ], "type": "string", "description": "The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2" }, "TargetEnforcement": { "enum": [ "Required", "Optional", "Adhoc", "Onboarding" ], "type": "string", "description": "The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4" }, "TargetGroupFilter": { "enum": [ "All", "Servers", "Workstations", "PortableDevices", "WorkstationsAndPortableDevices", "DomainControllers", "PrimaryDomainControllers" ], "type": "string", "description": "The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6" }, "TargetScope": { "enum": [ "CrossTenant", "SingleTenant", "Individual" ], "type": "string", "description": "The string or integer value may be used. CrossTenant = 0, SingleTenant = 1, Individual = 2" }, "TargetType": { "enum": [ "All", "Computer", "Metascript", "Person", "AzureGroup", "TenantMetascript", "AllForTenant", "ProviderDeviceGroup", "ProviderClientGroup", "TenantFilterScript", "FilterScript", "AllTenants", "SpecificTenant", "Tag", "TenantTag", "CloudTag", "CloudProviderClientGroup" ], "type": "string", "description": "The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42" }, "TargetVisibility": { "enum": [ "SelfService", "TechnicianTools" ], "type": "string", "description": "The string or integer value may be used. SelfService = 1, TechnicianTools = 2" }, "TargetedPerson": { "required": [ "email", "name" ], "type": "object", "properties": { "personId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TechnicianPageInfoFromPsaTicket": { "type": "object", "properties": { "personId": { "type": "integer", "format": "int32", "nullable": true }, "personName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "computers": { "type": "array", "items": { "$ref": "#/components/schemas/UnifiedComputerInfo" }, "nullable": true }, "ticketEmailAddress": { "type": "string", "nullable": true }, "ticketClientId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Tenant": { "required": [ "name" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32", "nullable": true }, "parentTenant": { "$ref": "#/components/schemas/Tenant" }, "childTenants": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" }, "nullable": true, "readOnly": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "active": { "type": "boolean" }, "isMsp": { "type": "boolean" }, "azureTenantLink": { "$ref": "#/components/schemas/AzureTenantLink" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "smtpConfig": { "$ref": "#/components/schemas/SmtpConfig" }, "tenantPreferences": { "$ref": "#/components/schemas/TenantPreferences" }, "ownedTenants": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" }, "nullable": true, "readOnly": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true, "readOnly": true }, "providerClients": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderClient" }, "nullable": true, "readOnly": true }, "ownedProviderLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLink" }, "nullable": true, "readOnly": true }, "tenantSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/TenantSoftware" }, "nullable": true, "readOnly": true }, "detectedComputerSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedComputerSoftware" }, "nullable": true, "readOnly": true }, "scripts": { "type": "array", "items": { "$ref": "#/components/schemas/TenantScript" }, "nullable": true, "readOnly": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/TenantMedia" }, "nullable": true, "readOnly": true }, "maintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/TenantMaintenanceTask" }, "nullable": true, "readOnly": true }, "ownedLocalSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftware" }, "nullable": true, "readOnly": true }, "ownedMaintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTask" }, "nullable": true, "readOnly": true }, "ownedScripts": { "type": "array", "items": { "$ref": "#/components/schemas/Script" }, "nullable": true, "readOnly": true }, "ownedTags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true, "readOnly": true }, "ownedMedia": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "nullable": true, "readOnly": true }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" }, "nullable": true, "readOnly": true }, "computers": { "type": "array", "items": { "$ref": "#/components/schemas/Computer" }, "nullable": true }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "nullable": true }, "brandings": { "type": "array", "items": { "$ref": "#/components/schemas/Branding" }, "nullable": true, "readOnly": true }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/License" }, "nullable": true, "readOnly": true }, "maintenanceSessions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceSession" }, "nullable": true, "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true, "readOnly": true }, "tenantTagAuthorizations": { "type": "array", "items": { "$ref": "#/components/schemas/TenantTagAuthorization" }, "nullable": true, "readOnly": true }, "tenantTags": { "type": "array", "items": { "$ref": "#/components/schemas/TenantTag" }, "nullable": true, "readOnly": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "nullable": true, "readOnly": true }, "ownerTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/TenantDeletion" }, "nullable": true, "readOnly": true }, "targetAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignment" }, "nullable": true, "readOnly": true }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" }, "nullable": true, "readOnly": true }, "markedForDeletionAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TenantComputerCountResponse": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "computerCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TenantConsentRequestBody": { "type": "object", "properties": { "tenantPrincipalId": { "type": "string", "nullable": true }, "appType": { "$ref": "#/components/schemas/AppRegistrationType" } }, "additionalProperties": false }, "TenantConsentResponseBody": { "type": "object", "properties": { "tenantPrincipalId": { "type": "string", "nullable": true }, "isPartner": { "type": "boolean" } }, "additionalProperties": false }, "TenantDeletion": { "required": [ "deleteOwnedObjects", "newOwnerTenantId", "tenantId" ], "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/DeletionStatus" }, "completionMessage": { "type": "string", "nullable": true }, "newOwnerTenantId": { "type": "integer", "format": "int32", "nullable": true }, "newOwnerTenant": { "$ref": "#/components/schemas/Tenant" }, "deleteOwnedObjects": { "type": "boolean" } }, "additionalProperties": false }, "TenantInfoResult": { "type": "object", "properties": { "principalId": { "type": "string", "nullable": true }, "result": { "$ref": "#/components/schemas/AzureTenantInfoAzureErrorOneOf" } }, "additionalProperties": false }, "TenantMaintenanceTask": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "maintenanceTaskId": { "type": "integer", "format": "int32" }, "relationship": { "$ref": "#/components/schemas/Relationship" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "maintenanceTask": { "$ref": "#/components/schemas/MaintenanceTask" } }, "additionalProperties": false }, "TenantMedia": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "mediaId": { "type": "integer", "format": "int32" }, "relationship": { "$ref": "#/components/schemas/Relationship" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "media": { "$ref": "#/components/schemas/Media" } }, "additionalProperties": false }, "TenantPreferences": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "enableOnboarding": { "type": "boolean" }, "enableSessionEmails": { "type": "boolean" }, "enableOnboardingPatching": { "type": "boolean" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "defaultEmailBccList": { "$ref": "#/components/schemas/DefaultEmailBccList" }, "overwriteExistingDeviceIfOSIsNew": { "type": "boolean" }, "requireConsentForExternalSessionProviders": { "type": "boolean", "nullable": true }, "businessHoursStart": { "type": "string", "nullable": true }, "businessHoursEnd": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "excludeFromCrossTenantDeploymentsAndSchedules": { "type": "boolean" }, "enableUserAffinitySync": { "type": "boolean" }, "enableImmyBotRemoteControl": { "type": "boolean", "nullable": true }, "enableImmyBotRemoteControlRecording": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TenantPreferencesOperation": { "type": "object", "properties": { "operationType": { "$ref": "#/components/schemas/OperationType" }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "TenantRestrictionMode": { "enum": [ "AllTenants", "Include", "Exclude" ], "type": "string", "description": "The string or integer value may be used. AllTenants = 0, Include = 1, Exclude = 2" }, "TenantScript": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "scriptId": { "type": "integer", "format": "int32" }, "relationship": { "$ref": "#/components/schemas/Relationship" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "TenantSoftware": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "softwareId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "software": { "$ref": "#/components/schemas/LocalSoftware" } }, "additionalProperties": false }, "TenantTag": { "type": "object", "properties": { "entityId": { "type": "integer", "format": "int32" }, "tagId": { "type": "integer", "format": "int32" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "additionalProperties": false }, "TenantTagAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "tagId": { "type": "integer", "format": "int32" }, "tagName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TenantTagAuthorization": { "type": "object", "properties": { "tagId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "relationship": { "$ref": "#/components/schemas/Relationship" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "additionalProperties": false }, "TestIntegrationBindConfigurationFormRequest": { "type": "object", "properties": { "parameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ParameterValue" }, "nullable": true } }, "additionalProperties": false }, "TestIntegrationMethodRequest": { "type": "object", "properties": { "providerTypeFormData": { } }, "additionalProperties": false }, "TimeZoneResource": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TimelineEvent": { "required": [ "objectId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "dateUTC": { "type": "string", "format": "date-time" }, "eventType": { "$ref": "#/components/schemas/TimelineEventType" }, "objectType": { "$ref": "#/components/schemas/TimelineObjectType" }, "objectId": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "TimelineEventType": { "enum": [ "AgentConnected", "AgentDisconnected", "AgentCreated", "AgentDeleted", "MaintenanceActionStarted", "MaintenanceActionCompleted", "ComputerOnline", "ComputerOffline", "EphemeralAgentSessionCreated", "EphemeralAgentSessionConnected", "EphemeralAgentSessionConnectionTimeout", "EphemeralAgentSessionNotConnected", "EphemeralAgentSessionConnectionLost", "EphemeralAgentSessionIdleShutdown", "EphemeralAgentSessionZombieKill", "EphemeralAgentSessionCreationFailure", "EphemeralAgentSessionDisconnected", "RemoteSessionStarted", "RemoteSessionEnded", "EphemeralAgentSessionUpdateInstall", "AgentUpdated", "EphemeralAgentSessionAlreadyConnected", "EphemeralAgentSessionDisposed" ], "type": "string", "description": "The string or integer value may be used. AgentConnected = 1, AgentDisconnected = 2, AgentCreated = 3, AgentDeleted = 4, MaintenanceActionStarted = 5, MaintenanceActionCompleted = 6, ComputerOnline = 7, ComputerOffline = 8, EphemeralAgentSessionCreated = 9, EphemeralAgentSessionConnected = 10, EphemeralAgentSessionConnectionTimeout = 11, EphemeralAgentSessionNotConnected = 12, EphemeralAgentSessionConnectionLost = 13, EphemeralAgentSessionIdleShutdown = 14, EphemeralAgentSessionZombieKill = 15, EphemeralAgentSessionCreationFailure = 16, EphemeralAgentSessionDisconnected = 17, RemoteSessionStarted = 18, RemoteSessionEnded = 19, EphemeralAgentSessionUpdateInstall = 20, AgentUpdated = 21, EphemeralAgentSessionAlreadyConnected = 22, EphemeralAgentSessionDisposed = 23" }, "TimelineObjectType": { "enum": [ "Computer", "ProviderAgent", "Tenant" ], "type": "string", "description": "The string or integer value may be used. Computer = 1, ProviderAgent = 2, Tenant = 3" }, "ToggleApplicationLogStreamingRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "Type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isInterface": { "type": "boolean", "readOnly": true }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TypeAttributes": { "enum": [ "NotPublic", "AutoLayout", "AnsiClass", "Class", "Public", "NestedPublic", "NestedPrivate", "NestedFamily", "NestedAssembly", "NestedFamANDAssem", "VisibilityMask", "NestedFamORAssem", "SequentialLayout", "ExplicitLayout", "LayoutMask", "Interface", "ClassSemanticsMask", "Abstract", "Sealed", "SpecialName", "RTSpecialName", "Import", "Serializable", "WindowsRuntime", "UnicodeClass", "AutoClass", "StringFormatMask", "CustomFormatClass", "HasSecurity", "ReservedMask", "BeforeFieldInit", "CustomFormatMask" ], "type": "string", "description": "The string or integer value may be used. NotPublic = 0, AutoLayout = 0, AnsiClass = 0, Class = 0, Public = 1, NestedPublic = 2, NestedPrivate = 3, NestedFamily = 4, NestedAssembly = 5, NestedFamANDAssem = 6, VisibilityMask = 7, NestedFamORAssem = 7, SequentialLayout = 8, ExplicitLayout = 16, LayoutMask = 24, Interface = 32, ClassSemanticsMask = 32, Abstract = 128, Sealed = 256, SpecialName = 1024, RTSpecialName = 2048, Import = 4096, Serializable = 8192, WindowsRuntime = 16384, UnicodeClass = 65536, AutoClass = 131072, StringFormatMask = 196608, CustomFormatClass = 196608, HasSecurity = 262144, ReservedMask = 264192, BeforeFieldInit = 1048576, CustomFormatMask = 12582912" }, "TypeInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isInterface": { "type": "boolean", "readOnly": true }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true }, "genericTypeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "declaredConstructors": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructorInfo" }, "nullable": true, "readOnly": true }, "declaredEvents": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "nullable": true, "readOnly": true }, "declaredFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true, "readOnly": true }, "declaredMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" }, "nullable": true, "readOnly": true }, "declaredMethods": { "type": "array", "items": { "$ref": "#/components/schemas/MethodInfo" }, "nullable": true, "readOnly": true }, "declaredNestedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "declaredProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyInfo" }, "nullable": true, "readOnly": true }, "implementedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UnifiedComputerInfo": { "type": "object", "properties": { "computerId": { "type": "integer", "format": "int32" }, "computerName": { "type": "string", "nullable": true }, "isOnline": { "type": "boolean" } }, "additionalProperties": false }, "UnlinkClientsRequestBody": { "required": [ "clientIds" ], "type": "object", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateActionType": { "enum": [ "None", "UninstallInstall", "InstallOver", "UpgradeScript" ], "type": "string", "description": "The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3" }, "UpdateApplicationLogSourceContextRequest": { "type": "object", "properties": { "sourceContext": { "type": "string", "nullable": true }, "minimumLevel": { "$ref": "#/components/schemas/LogLevel" } }, "additionalProperties": false }, "UpdateAzureTenantAuthDetailsCmdPayload": { "type": "object", "properties": { "authDetails": { "$ref": "#/components/schemas/AzureTenantAuthDetails" } }, "additionalProperties": false }, "UpdateAzureTenantAuthDetailsCmdResult": { "type": "object", "properties": { "authDetails": { "$ref": "#/components/schemas/AzureTenantAuthDetails" }, "defaultAppRegistrationUpdated": { "type": "boolean" } }, "additionalProperties": false }, "UpdateAzureTenantLinkRequest": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "principalId": { "type": "string", "nullable": true }, "partnerPrincipalId": { "type": "string", "nullable": true }, "limitToDomains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "removeSyncedUsers": { "type": "boolean" }, "unlinkCustomers": { "type": "boolean" }, "removeCustomersSyncedUsers": { "type": "boolean" } }, "additionalProperties": false }, "UpdateBrandingRequestBody": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "ignoreYear": { "type": "boolean", "nullable": true }, "timeFormat": { "type": "string", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "mascotImgUri": { "type": "string", "nullable": true }, "mascotName": { "type": "string", "nullable": true }, "logoUri": { "type": "string", "nullable": true }, "logoAltText": { "type": "string", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "foregroundColor": { "type": "string", "nullable": true }, "tableHeaderColor": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tableHeaderTextColor": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateComputerAdditionalPersonsRequestBody": { "type": "object", "properties": { "additionalPersonIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "UpdateComputerPrimaryPersonRequestBody": { "type": "object", "properties": { "primaryPersonId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateComputerRequestBody": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "additionalPersonIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "onboardingStatus": { "$ref": "#/components/schemas/ComputerOnboardingStatus" }, "providerLinkUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLinkUpdate" }, "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDynamicIntegrationTypePayload": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "scriptId": { "type": "integer", "format": "int32" }, "logoId": { "type": "integer", "format": "int32" }, "docsUrl": { "type": "string", "nullable": true }, "tag": { "$ref": "#/components/schemas/IntegrationTag" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateExpirationRequest": { "type": "object", "properties": { "personIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "expiresIn": { "$ref": "#/components/schemas/ExpirationTime" } }, "additionalProperties": false }, "UpdateGlobalMaintenanceTaskPayload": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "onboardingOnly": { "type": "boolean" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "recommended": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterPayload" }, "nullable": true, "readOnly": true }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "executeSerially": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "useScriptParamBlock": { "type": "boolean" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdateGlobalMediaPayload": { "required": [ "fileName", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "blobReference": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/MediaCategory" } }, "additionalProperties": false }, "UpdateGlobalScriptRequestBody": { "required": [ "action", "name" ], "type": "object", "properties": { "action": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" } }, "additionalProperties": false }, "UpdateGlobalSoftwareRequestBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "licenseDescription": { "type": "string", "nullable": true }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairType": { "type": "integer", "format": "int32", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "upgradeCode": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "softwareId": { "type": "integer", "format": "int32" }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true } }, "additionalProperties": false }, "UpdateGlobalSoftwareVersionRequestBody": { "required": [ "semanticVersion" ], "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "blobName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareId": { "type": "integer", "format": "int32" }, "currentSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UpdateGlobalTargetAssignmentPayload": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "excluded": { "type": "boolean" }, "onboardingOnly": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" } }, "additionalProperties": false }, "UpdateGroupRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateLicenseRequestBody": { "required": [ "licenseValue", "name", "softwareIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "licenseValue": { "type": "string", "nullable": true }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true }, "softwareName": { "type": "string", "description": "Set in controller, not by the frontend", "nullable": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "restrictToMajorVersion": { "type": "boolean" } }, "additionalProperties": false }, "UpdateLocalMaintenanceTaskPayload": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "onboardingOnly": { "type": "boolean" }, "ignoreDuringAutomaticOnboarding": { "type": "boolean" }, "testEnabled": { "type": "boolean" }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "getEnabled": { "type": "boolean" }, "getScriptId": { "type": "integer", "format": "int32", "nullable": true }, "getScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "setEnabled": { "type": "boolean" }, "setScriptId": { "type": "integer", "format": "int32", "nullable": true }, "setScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskCategory": { "$ref": "#/components/schemas/MaintenanceTaskCategory" }, "recommended": { "type": "boolean" }, "isConfigurationTask": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTaskParameterPayload" }, "nullable": true, "readOnly": true }, "iconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "executeSerially": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "useScriptParamBlock": { "type": "boolean" }, "supersededByTaskId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "supersededByTaskMigrationScriptId": { "type": "integer", "format": "int32", "nullable": true }, "supersededByTaskMigrationScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "integrationTypeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdateLocalMediaPayload": { "required": [ "fileName", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "blobReference": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/MediaCategory" } }, "additionalProperties": false }, "UpdateLocalScriptRequestBody": { "required": [ "action", "name" ], "type": "object", "properties": { "action": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "scriptLanguage": { "$ref": "#/components/schemas/ScriptLanguage" }, "scriptExecutionContext": { "$ref": "#/components/schemas/ScriptExecutionContext" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "scriptCategory": { "$ref": "#/components/schemas/ScriptCategory" }, "outputType": { "$ref": "#/components/schemas/ScriptOutputType" }, "timeout": { "type": "integer", "format": "int32", "nullable": true }, "filterScriptMode": { "$ref": "#/components/schemas/FilterScriptMode" }, "scriptCacheName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateLocalSoftwareRequestBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "licenseRequirement": { "$ref": "#/components/schemas/SoftwareLicenseRequirement" }, "licenseDescription": { "type": "string", "nullable": true }, "installOrder": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "detectionScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairScriptId": { "type": "integer", "format": "int32", "nullable": true }, "repairType": { "type": "integer", "format": "int32", "nullable": true }, "softwareTableName": { "type": "string", "nullable": true }, "maintenanceTaskId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "rebootNeeded": { "type": "boolean" }, "upgradeCode": { "type": "string", "nullable": true }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod" }, "softwareTableNameSearchMode": { "$ref": "#/components/schemas/SoftwareTableNameSearchMode" }, "softwareIconMediaId": { "type": "integer", "format": "int32", "nullable": true }, "recommended": { "type": "boolean" }, "chocoProviderSoftwareId": { "type": "string", "nullable": true }, "niniteProviderSoftwareId": { "type": "string", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "testRequired": { "type": "boolean" }, "testFailedError": { "type": "string", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "useDynamicVersions": { "type": "boolean" }, "dynamicVersionsScriptId": { "type": "integer", "format": "int32", "nullable": true }, "downloadInstallerScriptId": { "type": "integer", "format": "int32", "nullable": true }, "agentIntegrationTypeId": { "type": "string", "format": "uuid", "nullable": true }, "softwareId": { "type": "integer", "format": "int32" }, "softwarePrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePrerequisite" }, "nullable": true }, "detectionScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceTaskType": { "$ref": "#/components/schemas/DatabaseType" }, "repairScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "dynamicVersionsScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "downloadInstallerScriptType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "UpdateLocalSoftwareVersionRequestBody": { "required": [ "semanticVersion" ], "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "displayVersion": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "testRequired": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "relativeCacheSourcePath": { "type": "string", "nullable": true }, "installerFile": { "type": "string", "nullable": true }, "testFailedError": { "type": "string", "nullable": true }, "packageHash": { "type": "string", "nullable": true }, "testScriptId": { "type": "integer", "format": "int32", "nullable": true }, "installScriptId": { "type": "integer", "format": "int32", "nullable": true }, "uninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "upgradeScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postUninstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "postInstallScriptId": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "$ref": "#/components/schemas/LicenseType" }, "upgradeStrategy": { "$ref": "#/components/schemas/UpdateActionType" }, "packageType": { "$ref": "#/components/schemas/PackageType" }, "installerType": { "$ref": "#/components/schemas/SoftwareVersionInstallerType" }, "blobName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "dependsOnSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareId": { "type": "integer", "format": "int32" }, "currentSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "softwareType": { "$ref": "#/components/schemas/SoftwareType" }, "softwareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "installScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "testScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "upgradeScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "uninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postUninstallScriptType": { "$ref": "#/components/schemas/DatabaseType" }, "postInstallScriptType": { "$ref": "#/components/schemas/DatabaseType" } }, "additionalProperties": false }, "UpdateLocalTargetAssignmentPayload": { "required": [ "maintenanceIdentifier" ], "type": "object", "properties": { "maintenanceIdentifier": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "licenseId": { "type": "integer", "format": "int32", "nullable": true }, "softwareSemanticVersion": { "$ref": "#/components/schemas/SemanticVersion" }, "desiredSoftwareState": { "$ref": "#/components/schemas/DesiredSoftwareState" }, "maintenanceTaskMode": { "$ref": "#/components/schemas/MaintenanceTaskMode" }, "taskParameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeploymentParameterValue" }, "nullable": true }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "softwareProviderType": { "$ref": "#/components/schemas/SoftwareProviderType" }, "excluded": { "type": "boolean" }, "targetEnforcement": { "$ref": "#/components/schemas/TargetEnforcement" }, "onboardingOnly": { "type": "boolean" }, "providerLinkIdForMaintenanceItem": { "type": "integer", "format": "int32", "nullable": true }, "targetVisibility": { "$ref": "#/components/schemas/TargetAssignmentVisibilityPayload" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateMaintenanceItemOrderPayload": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "toIndex": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/MaintenanceItemOrderLocation" } }, "additionalProperties": false }, "UpdateNotesPayload": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateOptionalTargetAssignmentApprovalPayload": { "type": "object", "properties": { "targetAssignmentId": { "type": "integer", "format": "int32" }, "approved": { "$ref": "#/components/schemas/TargetAssignmentApprovalStatus" }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "target": { "type": "string", "nullable": true }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" } }, "additionalProperties": false }, "UpdatePersonPayload": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "azurePrincipalId": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateProviderLinkRequestBody": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" }, "providerTypeFormData": { }, "excludedCapabilities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateRecommendedApprovalPayload": { "type": "object", "properties": { "globalTargetAssignmentId": { "type": "integer", "format": "int32" }, "approved": { "type": "boolean" } }, "additionalProperties": false }, "UpdateRecommendedApprovalsRequestBody": { "type": "object", "properties": { "approvals": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateRecommendedApprovalPayload" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UpdateReleaseChannelRequest": { "type": "object", "properties": { "releaseChannel": { "$ref": "#/components/schemas/ReleaseChannel" } }, "additionalProperties": false }, "UpdateScheduleRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true }, "targetType": { "$ref": "#/components/schemas/TargetType" }, "targetGroupFilter": { "$ref": "#/components/schemas/TargetGroupFilter" }, "targetCategory": { "$ref": "#/components/schemas/TargetCategory" }, "providerDeviceGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerClientGroupType": { "type": "string", "format": "uuid", "nullable": true }, "providerLinkId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "propagateToChildTenants": { "type": "boolean" }, "customCronExpression": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "day": { "type": "integer", "format": "int32", "nullable": true }, "maintenanceTime": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" }, "sendDetectionEmail": { "type": "boolean" }, "sendDetectionEmailWhenAllActionsAreCompliant": { "type": "boolean" }, "sendFollowUpEmail": { "type": "boolean" }, "sendFollowUpOnlyIfActionNeeded": { "type": "boolean" }, "showRunNowButton": { "type": "boolean" }, "showPostponeButton": { "type": "boolean" }, "maintenanceType": { "$ref": "#/components/schemas/MaintenanceType" }, "maintenanceIdentifier": { "type": "string", "nullable": true }, "timeZoneInfoId": { "type": "string", "nullable": true }, "rebootPreference": { "$ref": "#/components/schemas/RebootPreference" }, "promptTimeoutAction": { "$ref": "#/components/schemas/PromptTimeoutAction" }, "autoConsentToReboots": { "type": "boolean" }, "promptTimeoutMinutes": { "type": "integer", "format": "int32" }, "applyWindowsUpdates": { "type": "boolean" }, "showMaintenanceActions": { "type": "boolean" }, "allowAccessToMSPResources": { "type": "boolean" }, "allowAccessToParentTenant": { "type": "boolean" }, "offlineBehavior": { "$ref": "#/components/schemas/ComputerOfflineMaintenanceSessionBehavior" }, "suppressRebootsDuringBusinessHours": { "type": "boolean" }, "useComputersTimezoneForExecution": { "type": "boolean" }, "scheduleExecutionAfterActiveHours": { "type": "boolean" } }, "additionalProperties": false }, "UpdateTagPayload": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateTargetVisibilityPayload": { "type": "object", "properties": { "targetVisibility": { "$ref": "#/components/schemas/TargetVisibility" }, "updateStatus": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateTenantPayload": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "parentTenantId": { "type": "integer", "format": "int32", "nullable": true }, "isMsp": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateUserPayload": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "isAdmin": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "canManageCrossTenantDeployments": { "type": "boolean" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userName": { "type": "string", "nullable": true }, "normalizedUserName": { "type": "string", "nullable": true }, "normalizedEmail": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "type": "string", "nullable": true }, "securityStamp": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "phoneNumberConfirmed": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32" }, "expirationDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "isAdmin": { "type": "boolean" }, "canManageCrossTenantDeployments": { "type": "boolean", "deprecated": true }, "servicePrincipalId": { "type": "string", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "person": { "$ref": "#/components/schemas/Person" }, "ownerTenant": { "$ref": "#/components/schemas/Tenant" }, "isSupportTechnician": { "type": "boolean" }, "isMigrated": { "type": "boolean" }, "displayName": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "azurePrincipalId": { "type": "string", "nullable": true, "readOnly": true }, "hasManagementAccess": { "type": "boolean", "deprecated": true }, "createdDeployments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignment" }, "nullable": true }, "updatedDeployments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignment" }, "nullable": true }, "createdScripts": { "type": "array", "items": { "$ref": "#/components/schemas/Script" }, "nullable": true }, "updatedScripts": { "type": "array", "items": { "$ref": "#/components/schemas/Script" }, "nullable": true }, "createdPersons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "nullable": true }, "updatedPersons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" }, "nullable": true }, "createdSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftware" }, "nullable": true }, "updatedSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftware" }, "nullable": true }, "createdSoftwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftwareVersion" }, "nullable": true }, "updatedSoftwareVersions": { "type": "array", "items": { "$ref": "#/components/schemas/LocalSoftwareVersion" }, "nullable": true }, "createdLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/License" }, "nullable": true }, "updatedLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/License" }, "nullable": true }, "createdMaintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTask" }, "nullable": true }, "updatedMaintenanceTasks": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceTask" }, "nullable": true }, "createdSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" }, "nullable": true }, "updatedSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" }, "nullable": true }, "createdProviderLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLink" }, "nullable": true }, "updatedProviderLinks": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLink" }, "nullable": true }, "createdBrandings": { "type": "array", "items": { "$ref": "#/components/schemas/Branding" }, "nullable": true }, "updatedBrandings": { "type": "array", "items": { "$ref": "#/components/schemas/Branding" }, "nullable": true }, "createdMedia": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "nullable": true }, "updatedMedia": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "nullable": true }, "createdTags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true }, "updatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true }, "createdRecommendedTargetAssignmentApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/RecommendedTargetAssignmentApproval" }, "nullable": true }, "updatedRecommendedTargetAssignmentApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/RecommendedTargetAssignmentApproval" }, "nullable": true }, "createdMaintenanceSessions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceSession" }, "nullable": true }, "accessRequestAcknowledgements": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRequest" }, "nullable": true }, "userRoles": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" }, "nullable": true, "deprecated": true }, "userRoleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignment" }, "nullable": true }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "nullable": true }, "silencedNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/UserSilencedNotification" }, "nullable": true }, "createdChangeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" }, "nullable": true }, "updatedChangeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" }, "nullable": true }, "createdChangeRequestComments": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestComment" }, "nullable": true }, "updatedChangeRequestComments": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequestComment" }, "nullable": true }, "userImpersonations": { "type": "array", "items": { "$ref": "#/components/schemas/UserImpersonation" }, "nullable": true }, "impersonatedByUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserImpersonation" }, "nullable": true }, "impersonatorUser": { "$ref": "#/components/schemas/User" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "customAuditProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AuditPropertyChange" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserAffinity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "computerId": { "type": "integer", "format": "int32" }, "computer": { "$ref": "#/components/schemas/Computer" }, "person": { "$ref": "#/components/schemas/Person" }, "personId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserAuthInfo": { "required": [ "expirationSecondsSinceEpoch", "userDisplayName", "userEmailAddress" ], "type": "object", "properties": { "userEmailAddress": { "type": "string", "nullable": true }, "userDisplayName": { "type": "string", "nullable": true }, "expirationSecondsSinceEpoch": { "type": "integer", "format": "int64" }, "expirationDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserGroup": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32" }, "user": { "$ref": "#/components/schemas/User" }, "group": { "$ref": "#/components/schemas/Group" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "auditObjectName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserImpersonation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "impersonatorUserId": { "type": "integer", "format": "int32" }, "impersonatingUserId": { "type": "integer", "format": "int32" }, "expiresAtUtc": { "type": "string", "format": "date-time" }, "impersonatorUser": { "$ref": "#/components/schemas/User" }, "impersonatingUser": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "UserPreferences": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "maskPiiData": { "type": "boolean" } }, "additionalProperties": false }, "UserPreferencesOperation": { "type": "object", "properties": { "operationType": { "$ref": "#/components/schemas/OperationType" }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "UserRole": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "user": { "$ref": "#/components/schemas/User" }, "role": { "$ref": "#/components/schemas/Role" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "auditObjectName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserRoleAssignment": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "user": { "$ref": "#/components/schemas/User" }, "group": { "$ref": "#/components/schemas/Group" }, "role": { "$ref": "#/components/schemas/Role" }, "createdByUser": { "$ref": "#/components/schemas/User" }, "updatedByUser": { "$ref": "#/components/schemas/User" }, "auditObjectName": { "type": "string", "nullable": true, "readOnly": true }, "auditObjectType": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserRoleAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserRoleAssignmentType": { "enum": [ "Owner", "Msp", "TenantTag", "SpecificTenant", "UserTenant", "TagResource", "SpecificResource", "CategoryResource" ], "type": "string", "description": "The string or integer value may be used. Owner = 1, Msp = 2, TenantTag = 3, SpecificTenant = 4, UserTenant = 5, TagResource = 6, SpecificResource = 7, CategoryResource = 8" }, "UserSilencedNotification": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "notificationObjectId": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "UserSilencedNotificationResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "notificationObjectId": { "type": "string", "nullable": true }, "dateSilencedUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserTenantAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "isAllow": { "type": "boolean" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "assignmentType": { "$ref": "#/components/schemas/UserRoleAssignmentType" }, "tenantId": { "type": "integer", "format": "int32" }, "tenantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateParamBlockParametersFromScriptRequest": { "type": "object", "properties": { "script": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "parameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ParameterValue" }, "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "forceRebind": { "type": "boolean" }, "validateRequiresOverrideForOnboarding": { "type": "boolean" }, "terminalId": { "type": "string", "format": "uuid", "nullable": true }, "maintenanceSessionId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValidateParamBlockParametersFromTaskRequest": { "type": "object", "properties": { "maintenanceTaskId": { "type": "integer", "format": "int32" }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "parameterValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ParameterValue" }, "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "computerId": { "type": "integer", "format": "int32", "nullable": true }, "personId": { "type": "integer", "format": "int32", "nullable": true }, "forceRebind": { "type": "boolean" }, "terminalId": { "type": "string", "format": "uuid", "nullable": true }, "deploymentId": { "type": "integer", "format": "int32", "nullable": true }, "deploymentDatabaseType": { "$ref": "#/components/schemas/DatabaseType" }, "maintenanceSessionId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } } } }