{ "openapi" : "3.0.1", "info" : { "title" : "Outpost24 REST API", "description" : "A REST API for the Outpost24 products.", "version" : "22.0.2" }, "servers" : [ { "url" : "/rest", "description" : "Base URL for all endpoints." } ], "paths" : { "/about" : { "get" : { "tags" : [ "about" ], "summary" : "Retrieve the list of software versions", "operationId" : "getVersionList", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VersionInfo" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/accounts/{accountId}" : { "get" : { "tags" : [ "accounts" ], "summary" : "Get a account", "operationId" : "getAccount", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Account" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "accounts" ], "summary" : "Delete a account", "operationId" : "deleteAccount", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "accounts" ], "summary" : "Partially update a account", "operationId" : "patchAccount", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Account" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } } }, "/accounts/{accountId}/tags/{tagId}" : { "put" : { "tags" : [ "accounts" ], "summary" : "Create a link to a tag", "operationId" : "putAccountTagLink", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "accounts" ], "summary" : "Delete a link to a tag", "operationId" : "deleteAccountTagLink", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } } }, "/accounts" : { "get" : { "tags" : [ "accounts" ], "summary" : "Get a list of accounts", "operationId" : "getAccountList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Account" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "accounts" ], "summary" : "Create a account", "operationId" : "postAccount", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Account" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "accounts" ], "summary" : "Get header with count", "operationId" : "getAccountHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } } }, "/accounts/{accountId}/tags" : { "put" : { "tags" : [ "accounts" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks", "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } } }, "/agents/installers/download" : { "get" : { "tags" : [ "agents" ], "summary" : "Download an agent installer (Deprecated: 2024-5-21)", "operationId" : "downloadInstaller", "parameters" : [ { "name" : "platform", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "arch", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "pkg", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "customAttributes", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tags", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "agents" ], "summary" : "Request for creating an agent installer", "operationId" : "requestInstallerCreation", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AgentInstallerCreationRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/agents/{agentUuid}/logs" : { "get" : { "tags" : [ "agents" ], "summary" : "Get agent logs", "operationId" : "getAgentLogs", "parameters" : [ { "name" : "agentUuid", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "long" } } }, "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/agents/version" : { "get" : { "tags" : [ "agents" ], "summary" : "Retrieve the agent version", "operationId" : "getAgentVersion", "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/agents/installers/configuration" : { "get" : { "tags" : [ "agents" ], "summary" : "Download agent installer configuration file", "operationId" : "getInstallerConfiguration", "parameters" : [ { "name" : "customAttributes", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tags", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/agents/installers" : { "get" : { "tags" : [ "agents" ], "summary" : "Get agent installers", "operationId" : "getInstallers", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/announcements" : { "get" : { "tags" : [ "announcements" ], "summary" : "Get a list of announcements", "operationId" : "getAnnouncements", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Announcement" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "announcementsadmin", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "announcements" ], "summary" : "Create and send an announcement", "operationId" : "postAnnouncement", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Announcement" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Announcement" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "announcementsadmin", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "announcements" ], "summary" : "Get header with count", "operationId" : "getAnnouncementsCount", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "announcementsadmin", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/appliances/{applianceId}" : { "get" : { "tags" : [ "appliances" ], "summary" : "Get an appliance (Deprecated 2025-09-25)", "operationId" : "getAppliance", "parameters" : [ { "name" : "applianceId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Appliance" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } } }, "/appliances/legacy" : { "get" : { "tags" : [ "appliances" ], "summary" : "Get a list of appliances", "operationId" : "getApplianceList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Appliance" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } }, "head" : { "tags" : [ "appliances" ], "summary" : "Get header with count", "operationId" : "getApplianceHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } } }, "/appliances" : { "get" : { "tags" : [ "appliances" ], "summary" : "Get a list of appliances (Deprecated 2025-09-25)", "operationId" : "getApplianceListOld", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Appliance" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } }, "head" : { "tags" : [ "appliances" ], "summary" : "Get header with count (Deprecated 2025-09-25)", "operationId" : "getApplianceHeaderOld", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } } }, "/appliances/legacy/{applianceId}" : { "get" : { "tags" : [ "appliances" ], "summary" : "Get an appliance", "operationId" : "getApplianceOld", "parameters" : [ { "name" : "applianceId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Appliance" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "APPLIANCES_VIEW" } } }, "/asset-groups/{assetGroupId}/subscriptions/{subscriptionUuid}" : { "put" : { "tags" : [ "asset-groups" ], "summary" : "Associate a subscription to the given asset group", "operationId" : "associateSubscriptionToAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Dissociate a subscription from the given asset group", "operationId" : "dissociateSubscriptionFromAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "" } } }, "/asset-groups/{assetGroupId}/activities/{activityId}" : { "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete an activity", "operationId" : "deleteActivity", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "activityId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get an asset group", "operationId" : "getAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetGroup" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete an asset group", "operationId" : "deleteAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "asset-groups" ], "summary" : "Partially update an asset group", "operationId" : "patchAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/AssetGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/accounts/{accountId}" : { "put" : { "tags" : [ "asset-groups" ], "summary" : "Create a link to an account", "operationId" : "putAssetGroupAccountLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Unlink asset group and account", "operationId" : "deleteAssetGroupAccountLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "" } } }, "/asset-groups/{assetGroupId}/assets/{assetId}" : { "put" : { "tags" : [ "asset-groups" ], "summary" : "Create a link to an asset", "operationId" : "putAssetGroupAssetLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE|ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete a link to an asset", "operationId" : "deleteAssetGroupAssetLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE|ASSETS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/tags/{tagId}" : { "put" : { "tags" : [ "asset-groups" ], "summary" : "Create a link to a tag", "operationId" : "putAssetGroupTagLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete an existing link to a tag", "operationId" : "deleteAssetGroupTagLink", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/comments/{commentId}" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get a comment for an asset group", "operationId" : "getCommentForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete a comment for an asset group", "operationId" : "deleteCommentForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "asset-groups" ], "summary" : "Partially update a comment for an asset group", "operationId" : "patchCommentForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups/comments" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get comments", "operationId" : "getAssetGroupComments", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "asset-groups" ], "summary" : "Add a comment to one or several asset groups", "operationId" : "postCommentForAssetGroups", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-groups" ], "summary" : "Delete one or several comments for one or several asset groups", "operationId" : "deleteCommentsForAssetGroups", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "asset-groups" ], "summary" : "Get header with count", "operationId" : "getAssetGroupCommentCount", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/asset-groups/activities" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get activities", "operationId" : "getActivities", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Activity" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/asset-groups/{assetGroupId}/activities" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get activities", "operationId" : "getAssetGroupActivities", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Activity" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "asset-groups" ], "summary" : "Add an activity for an AssetGroup", "operationId" : "postActivityForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Activity" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "asset-groups" ], "summary" : "Get header with count", "operationId" : "getActivitiesCount", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get a list of asset groups", "operationId" : "getAssetGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "asset-groups" ], "summary" : "Create an asset group", "operationId" : "postAssetGroup", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "asset-groups" ], "summary" : "Get header with count", "operationId" : "getAssetGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/comments" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get the comments for an asset group", "operationId" : "getCommentsForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW|ASSET_GROUPS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "asset-groups" ], "summary" : "Add a comment for an asset group", "operationId" : "postCommentForAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/dynamic-tags" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get a list of tags for a dynamic group", "operationId" : "getDynamicTagList", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/asset-groups/{assetGroupId}/subscriptions" : { "get" : { "tags" : [ "asset-groups" ], "summary" : "Get subscriptions associated with the given asset group", "operationId" : "getSubscriptionsAssociatedWithAssetGroup", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Subscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/asset-groups/{assetGroupId}/tags" : { "put" : { "tags" : [ "asset-groups" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_1", "parameters" : [ { "name" : "assetGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSET_GROUPS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}" : { "get" : { "tags" : [ "asset-identifiers" ], "summary" : "Get an asset identifier", "operationId" : "getAssetIdentifier", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetIdentifier" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-identifiers" ], "summary" : "Delete an asset identifier", "operationId" : "deleteAssetIdentifier", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "asset-identifiers" ], "summary" : "Partially update an asset identifier", "operationId" : "patchAssetIdentifier", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/AssetIdentifier" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}/links/{assetIdentifierLinkId}" : { "delete" : { "tags" : [ "asset-identifiers" ], "summary" : "Delete an asset identifier link", "operationId" : "deleteAssetIdentifierLink", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetIdentifierLinkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}" : { "get" : { "tags" : [ "asset-identifiers" ], "summary" : "Get the screenshot file for an asset identifier", "operationId" : "getAssetIdentifierScreenshot", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "screenshotFilename", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE" } }, "put" : { "tags" : [ "asset-identifiers" ], "summary" : "Add screenshot to asset identifier", "operationId" : "postAssetIdentifierScreenshot", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "screenshotFilename", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "byte" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-identifiers" ], "summary" : "Delete the screenshot file for an asset identifier", "operationId" : "deleteAssetIdentifierScreenshot", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "screenshotFilename", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}/tags/{tagId}" : { "put" : { "tags" : [ "asset-identifiers" ], "summary" : "Create a link to a tag (Deprecated: 2025-11-25)", "operationId" : "putAssetIdentifierTagLink", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "asset-identifiers" ], "summary" : "Delete a link to a tag (Deprecated: 2025-11-25)", "operationId" : "deleteAssetIdentifierTagLink", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/asset-identifiers" : { "get" : { "tags" : [ "asset-identifiers" ], "summary" : "Get a list of asset identifiers", "operationId" : "getAssetIdentifierList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetIdentifier" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "asset-identifiers" ], "summary" : "Create an asset identifier", "operationId" : "postAssetIdentifier", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetIdentifier" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "asset-identifiers" ], "summary" : "Get header with count", "operationId" : "getAssetIdentifierHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}/screenshots" : { "get" : { "tags" : [ "asset-identifiers" ], "summary" : "Get the screenshot list for an asset identifier", "operationId" : "getAssetIdentifierScreenshots", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE" } } }, "/asset-identifiers/{assetIdentifierId}/links" : { "get" : { "tags" : [ "asset-identifiers" ], "summary" : "Get the links for an asset identifier", "operationId" : "getLinkListForAssetIdentifier", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetIdentifierLink" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "asset-identifiers" ], "summary" : "Create an asset identifier link", "operationId" : "postAssetIdentifierLink", "parameters" : [ { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetIdentifierLink" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}" : { "get" : { "tags" : [ "assets" ], "summary" : "Get an asset", "operationId" : "getAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "assets" ], "summary" : "Delete an asset", "operationId" : "deleteAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "assets" ], "summary" : "Partially update an asset", "operationId" : "patchAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/links/{assetLinkId}" : { "delete" : { "tags" : [ "assets" ], "summary" : "Delete an asset link", "operationId" : "deleteAssetLink", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetLinkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "assets" ], "summary" : "Partially update an asset link", "operationId" : "patchAssetLink", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetLinkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/AssetLink" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/tags/{tagId}" : { "put" : { "tags" : [ "assets" ], "summary" : "Create a link to a tag", "operationId" : "putAssetTagLink", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "assets" ], "summary" : "Delete a link to a tag", "operationId" : "deleteAssetTagLink", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/tags/{tagId}" : { "put" : { "tags" : [ "assets" ], "summary" : "Create one or several links to one a tag", "operationId" : "putAssetTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "assets" ], "summary" : "Delete one or several links to a tag", "operationId" : "deleteAssetTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets" : { "get" : { "tags" : [ "assets" ], "summary" : "Get a list of assets", "operationId" : "getAssetList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "assets" ], "summary" : "Create an asset", "operationId" : "postAsset", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "assets" ], "summary" : "Delete one or several assets", "operationId" : "deleteAssets", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "assets" ], "summary" : "Get header with count", "operationId" : "getAssetHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "assets" ], "summary" : "Partially update one or several assets", "operationId" : "patchAssets", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/links" : { "get" : { "tags" : [ "assets" ], "summary" : "Get the links for an asset", "operationId" : "getLinkListForAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetLink" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW|ASSETS_VIEW_AND_MANAGE|REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "assets" ], "summary" : "Create an asset link", "operationId" : "postAssetLink", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetLink" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/subscriptions" : { "get" : { "tags" : [ "assets" ], "summary" : "Get subscriptions associated with the given asset", "operationId" : "getSubscriptionsAssociatedWithAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Subscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/merge" : { "post" : { "tags" : [ "assets" ], "summary" : "Merge two or more assets into a single asset", "description" : "Merges the selected asset records. This will reassign all identifiers to the target asset. Findings and other historical data associated with the merged records will be invalidated and removed; the target's historical data will remain unaltered.", "externalDocs" : { "description" : "Outpost24 Knowledge Base", "url" : "https://kb.outpost24.com/kb/application-security-testing-appsec/appsec-asset-management/asset-management" }, "operationId" : "mergeAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/tags" : { "put" : { "tags" : [ "assets" ], "summary" : "Modify linked set of tags", "operationId" : "modifyAssetTagLinks", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/tags" : { "put" : { "tags" : [ "assets" ], "summary" : "Modify linked set of tags to one or several assets", "operationId" : "modifyAssetsTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/refresh-tags" : { "post" : { "tags" : [ "assets" ], "summary" : "Refresh tags", "description" : "Refresh tags should add all custom attributes as tags on the asset, except MAC attribute", "operationId" : "refreshTags", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/assets/{assetId}/split" : { "post" : { "tags" : [ "assets" ], "summary" : "Split an asset based on identifier subset", "description" : "Moves the selected identifiers into a new asset record. All findings will remain associated with the original asset.", "externalDocs" : { "description" : "Outpost24 Knowledge Base", "url" : "https://kb.outpost24.com/kb/application-security-testing-appsec/appsec-asset-management/asset-management" }, "operationId" : "splitAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ASSETS_VIEW_AND_MANAGE" } } }, "/audits/{auditId}" : { "get" : { "tags" : [ "audits" ], "summary" : "Get a audit by ID", "operationId" : "getAudit", "parameters" : [ { "name" : "auditId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Audit" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUDITS_VIEW" } } }, "/audits" : { "get" : { "tags" : [ "audits" ], "summary" : "Get a list of audits", "operationId" : "getAuditList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Audit" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUDITS_VIEW" } }, "head" : { "tags" : [ "audits" ], "summary" : "Get header with count", "operationId" : "getAuditHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUDITS_VIEW" } } }, "/auth/login" : { "get" : { "tags" : [ "auth" ], "summary" : "Get a token", "operationId" : "getAuthenticationToken", "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "auth" ], "summary" : "Log in with username and password", "operationId" : "login", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "required" : [ "password", "username" ], "type" : "object", "properties" : { "username" : { "minLength" : 1, "type" : "string" }, "password" : { "minLength" : 1, "type" : "string" }, "code" : { "type" : "string" }, "validUntil" : { "type" : "string", "description" : "When the token should expire, has to be in the future and in the ISO 8601 instant format", "format" : "date-time" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/auth/logout" : { "post" : { "tags" : [ "auth" ], "summary" : "Log out", "operationId" : "logout", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/auth/send-2fa-sms" : { "post" : { "tags" : [ "auth" ], "summary" : "Send an sms containing the two-factor authentication code to user", "operationId" : "sendTwoFactorAuthenticationCodeViaSms", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SendSmsRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/auth/setup-2fa" : { "post" : { "tags" : [ "auth" ], "summary" : "Set up 2FA for new users", "operationId" : "setup2FA", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "required" : [ "password", "twoFactorCode", "twoFactorSecret", "username" ], "type" : "object", "properties" : { "username" : { "minLength" : 1, "type" : "string" }, "password" : { "minLength" : 1, "type" : "string" }, "twoFactorSecret" : { "minLength" : 1, "type" : "string" }, "twoFactorCode" : { "minLength" : 1, "type" : "string" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/automation-rules/{automationRuleId}" : { "get" : { "tags" : [ "automation-rules" ], "summary" : "Get an automation rule by ID", "operationId" : "getAutomationRule", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutomationRule" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW|AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "automation-rules" ], "summary" : "Delete an automation rule", "operationId" : "deleteAutomationRule", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "automation-rules" ], "summary" : "Partially update an automation rule", "operationId" : "patchAutomationRule", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/AutomationRule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/automation-rules/{automationRuleId}/tags/{tagId}" : { "put" : { "tags" : [ "automation-rules" ], "summary" : "Create a link to a tag", "operationId" : "putAutomationRuleTagLink", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "automation-rules" ], "summary" : "Delete a link to a tag", "operationId" : "deleteAutomationRuleTagLink", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/automation-rules/tags/{tagId}" : { "put" : { "tags" : [ "automation-rules" ], "summary" : "Create one or several links to one a tag", "operationId" : "putAutomationRuleTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "automation-rules" ], "summary" : "Delete one or several links to a tag", "operationId" : "deleteAutomationRuleTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/automation-rules" : { "get" : { "tags" : [ "automation-rules" ], "summary" : "Get a list of automation rules", "operationId" : "getAutomationRuleList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AutomationRule" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW|AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "automation-rules" ], "summary" : "Create an automation rule", "operationId" : "postAutomationRule", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutomationRule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "automation-rules" ], "summary" : "Delete one or several automation rules", "operationId" : "deleteAutomationRules", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "automation-rules" ], "summary" : "Get header with count", "operationId" : "getAutomationRuleHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW|AUTOMATION_RULES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "automation-rules" ], "summary" : "Partially update one or several automation rule", "operationId" : "patchAutomationRules", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/AutomationRule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/automation-rules/{automationRuleId}/tags" : { "put" : { "tags" : [ "automation-rules" ], "summary" : "Modify linked set of tags", "operationId" : "modifyAutomationRuleTagLinks", "parameters" : [ { "name" : "automationRuleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/automation-rules/tags" : { "put" : { "tags" : [ "automation-rules" ], "summary" : "Modify linked set of tags to one or several automation rules", "operationId" : "modifyAutomationRulesTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "AUTOMATION_RULES_VIEW_AND_MANAGE" } } }, "/blueprints/download/{key}" : { "get" : { "tags" : [ "blueprints" ], "summary" : "Download a blueprint", "operationId" : "downloadBlueprint", "parameters" : [ { "name" : "key", "in" : "path", "required" : true, "schema" : { "pattern" : "[-a-f0-9]{32,36}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/certificate/renew" : { "post" : { "tags" : [ "certificate" ], "summary" : "Renews certificate", "operationId" : "renewCertificate", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CertificateCreationRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/checks/{checkId}/comments/{commentId}" : { "get" : { "tags" : [ "checks" ], "summary" : "Get a comment for a check", "operationId" : "getCommentForCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "checks" ], "summary" : "Delete a comment for a check", "operationId" : "deleteCommentForCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/checks/{checkId}" : { "get" : { "tags" : [ "checks" ], "summary" : "Get a check", "operationId" : "getCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Check" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/checks" : { "get" : { "tags" : [ "checks" ], "summary" : "Get a list of checks", "operationId" : "getChecksList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Check" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "checks" ], "summary" : "Get header with count", "operationId" : "getChecksHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/checks/{checkId}/comments" : { "get" : { "tags" : [ "checks" ], "summary" : "Get the comments for a check", "operationId" : "getCommentListForCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "checks" ], "summary" : "Add a comment for a check", "operationId" : "postCommentForCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/checks/{checkId}/exploits" : { "get" : { "tags" : [ "checks" ], "summary" : "Get the exploits for a check (Deprecated: 2026-05-25)", "operationId" : "getExploitListForCheck", "parameters" : [ { "name" : "checkId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "deprecated" : true, "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Exploit" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/classifications/{classificationId}" : { "get" : { "tags" : [ "classifications" ], "summary" : "Get a classification", "operationId" : "getClassification", "parameters" : [ { "name" : "classificationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/classifications" : { "get" : { "tags" : [ "classifications" ], "summary" : "Get a list of classifications", "operationId" : "getClassificationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Classification" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "classifications" ], "summary" : "Get header with count", "operationId" : "getClassificationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/compliance/findings/{findingId}/tags/{tagId}" : { "put" : { "tags" : [ "compliance" ], "summary" : "Create a link to a tag", "operationId" : "putComplianceFindingTagLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "compliance" ], "summary" : "Delete a link to a tag", "operationId" : "deleteComplianceFindingTagLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a compliance finding by ID", "operationId" : "getComplianceFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ComplianceFinding" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a list of compliance findings", "operationId" : "getComplianceFindingList", "parameters" : [ { "name" : "assetIdentifierId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComplianceFinding" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "compliance" ], "summary" : "Get header with count", "operationId" : "getComplianceFindingHeader", "parameters" : [ { "name" : "assetIdentifierId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/policies/{policyId}" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a compliance policy", "operationId" : "getCompliancePolicy", "parameters" : [ { "name" : "policyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/compliance/policies" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a list of compliance policies", "operationId" : "getCompliancePolicyList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Policy" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "compliance" ], "summary" : "Get header with count", "operationId" : "getCompliancePolicyHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/compliance/requirements/{requirementId}" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a compliance requirement", "operationId" : "getComplianceRequirement", "parameters" : [ { "name" : "requirementId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Requirement" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/requirements" : { "get" : { "tags" : [ "compliance" ], "summary" : "Get a list of requirements", "operationId" : "getComplianceRequirementList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Requirement" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "compliance" ], "summary" : "Get header with count", "operationId" : "getComplianceRequirementHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}/mark-exception" : { "post" : { "tags" : [ "compliance" ], "summary" : "Mark compliance finding as exception", "operationId" : "markExceptionForComplianceFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ComplianceFindingException" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}/mark-false-positive" : { "post" : { "tags" : [ "compliance" ], "summary" : "Mark compliance finding as false positive", "operationId" : "markFalsePositiveForComplianceFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ComplianceFindingFalsePositive" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}/tags" : { "put" : { "tags" : [ "compliance" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_2", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/reports" : { "post" : { "tags" : [ "compliance" ], "summary" : "Generate a compliance report", "operationId" : "requestComplianceReport", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ComplianceReport" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}/unmark-exception" : { "post" : { "tags" : [ "compliance" ], "summary" : "Unmark finding as exception", "operationId" : "unmarkExceptionForComplianceFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/compliance/findings/{findingId}/unmark-false-positive" : { "post" : { "tags" : [ "compliance" ], "summary" : "Unmark finding as false positive", "operationId" : "unmarkFalsePositiveForComplianceFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "COMPLIANCE_VIEW_AND_MANAGE" } } }, "/consumption-stats/{consumptionStatsId}" : { "get" : { "tags" : [ "consumption-stats" ], "summary" : "Get consumption stats by ID", "operationId" : "getConsumptionStats", "parameters" : [ { "name" : "consumptionStatsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsumptionStats" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/consumption-stats" : { "get" : { "tags" : [ "consumption-stats" ], "summary" : "Get a list of consumption stats", "operationId" : "getConsumptionStatsList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConsumptionStats" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "consumption-stats" ], "summary" : "Get header with count", "operationId" : "getConsumptionStatsHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/consumption-stats/{consumptionStatsId}/subscriptions" : { "get" : { "tags" : [ "consumption-stats" ], "summary" : "Get a list of subscriptions for consumption stats", "operationId" : "getConsumptionSubscriptions", "parameters" : [ { "name" : "consumptionStatsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Subscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/credential-classes/{credentialClassId}" : { "get" : { "tags" : [ "credential-classes" ], "summary" : "Get a credential class", "operationId" : "getCredentialClass", "parameters" : [ { "name" : "credentialClassId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CredentialClass" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } } }, "/credential-classes" : { "get" : { "tags" : [ "credential-classes" ], "summary" : "Get a list of credential classes", "operationId" : "getCredentialClassList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialClass" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "credential-classes" ], "summary" : "Get header with count", "operationId" : "getCredentialClassHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } } }, "/credentials/{credentialId}" : { "get" : { "tags" : [ "credentials" ], "summary" : "Get a credential", "operationId" : "getCredential", "parameters" : [ { "name" : "credentialId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Credential" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW|ACCOUNTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "credentials" ], "summary" : "Delete a credential", "operationId" : "deleteCredential", "parameters" : [ { "name" : "credentialId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "credentials" ], "summary" : "Partially update a credential", "operationId" : "patchCredential", "parameters" : [ { "name" : "credentialId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Credential" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } } }, "/credentials" : { "post" : { "tags" : [ "credentials" ], "summary" : "Create a credential", "operationId" : "postCredential", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Credential" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "ACCOUNTS_VIEW_AND_MANAGE" } } }, "/customers/{customerId}/tags/{tagId}" : { "put" : { "tags" : [ "customers" ], "summary" : "Create a link to a tag", "operationId" : "putCustomerTagLink", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "customers" ], "summary" : "Delete a link to a tag", "operationId" : "deleteCustomerTagLink", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}/consultancy" : { "get" : { "tags" : [ "customers" ], "summary" : "Get consultancy token", "operationId" : "getConsultancyToken", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "services|superswatservice|ghostlabs|admin|support|licensemanager|consultancy", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/me/consumption-stats/{consumptionStatsId}" : { "get" : { "tags" : [ "customers" ], "summary" : "Get consumption stats by ID for current customer", "operationId" : "getConsumptionStatsForCurrentCustomer", "parameters" : [ { "name" : "consumptionStatsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsumptionStats" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/customers/me/consumption-stats" : { "get" : { "tags" : [ "customers" ], "summary" : "Get consumption stats for current customer", "operationId" : "getConsumptionStatsListForCurrentCustomer", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConsumptionStats" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/customers/{customerId}/consumption-stats" : { "get" : { "tags" : [ "customers" ], "summary" : "Get consumption stats for a customer", "operationId" : "getConsumptionStatsListForCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConsumptionStats" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/me/consumption-stats/{consumptionStatsId}/subscriptions" : { "get" : { "tags" : [ "customers" ], "summary" : "Get a list of subscriptions for consumption stats for current customer", "operationId" : "getConsumptionSubscriptionsForCurrentCustomer", "parameters" : [ { "name" : "consumptionStatsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Subscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/customers/me" : { "get" : { "tags" : [ "customers" ], "summary" : "Get current customer", "operationId" : "getCurrentCustomer", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}" : { "get" : { "tags" : [ "customers" ], "summary" : "Get a customer", "operationId" : "getCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Customer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|legal|customersuccess|msspmanager|superswatservice|ghostlabs|services|salesmanager|accountmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "customers" ], "summary" : "Partially update a customer", "operationId" : "patchCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Customer" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/customers" : { "get" : { "tags" : [ "customers" ], "summary" : "Get a list of customers", "operationId" : "getCustomerList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Customer" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|legal|customersuccess|msspmanager|superswatservice|ghostlabs|services|salesmanager|accountmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "customers" ], "summary" : "Get header with count", "operationId" : "getCustomerHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|legal|customersuccess|msspmanager|superswatservice|ghostlabs|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}/usage-stats" : { "get" : { "tags" : [ "customers" ], "summary" : "Get usage stats for a customer", "operationId" : "getUsageStatsListForCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UsageStats" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/me/migrate" : { "post" : { "tags" : [ "customers" ], "summary" : "Migrate current customer", "operationId" : "migrateCurrentCustomer", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}/migrate" : { "post" : { "tags" : [ "customers" ], "summary" : "Migrate a customer", "operationId" : "migrateCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}/tags" : { "put" : { "tags" : [ "customers" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_3", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/me/reset-migration" : { "post" : { "tags" : [ "customers" ], "summary" : "Reset migration for current customer", "operationId" : "resetMigrationForCurrentCustomer", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/customers/{customerId}/reset-migration" : { "post" : { "tags" : [ "customers" ], "summary" : "Reset migration for a customer", "operationId" : "resetMigrationForCustomer", "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|services", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/cves/{cveId}" : { "get" : { "tags" : [ "cves" ], "summary" : "Get a CVE by ID", "operationId" : "getCve", "parameters" : [ { "name" : "cveId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cve" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/cves" : { "get" : { "tags" : [ "cves" ], "summary" : "Get a list of CVEs", "operationId" : "getCvesList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "cves" ], "summary" : "Get header with CVE count", "operationId" : "getCvesHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/dashboards/{dashboardId}" : { "get" : { "tags" : [ "dashboards" ], "summary" : "Get a dashboard", "operationId" : "getDashboard", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW|DASHBOARDS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "dashboards" ], "summary" : "Delete a dashboard", "operationId" : "deleteDashboard", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "dashboards" ], "summary" : "Partially update a dashboard", "operationId" : "patchDashboard", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } } }, "/dashboards/{dashboardId}/tags/{tagId}" : { "put" : { "tags" : [ "dashboards" ], "summary" : "Create a link to a tag", "operationId" : "putDashboardTagLink", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "dashboards" ], "summary" : "Delete a link to a tag", "operationId" : "deleteDashboardTagLink", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } } }, "/dashboards" : { "get" : { "tags" : [ "dashboards" ], "summary" : "Get a list of dashboards", "operationId" : "getDashboardList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Dashboard" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW|DASHBOARDS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "dashboards" ], "summary" : "Create a dashboard", "operationId" : "postDashboard", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "dashboards" ], "summary" : "Get header with count", "operationId" : "getDashboardHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW|DASHBOARDS_VIEW_AND_MANAGE" } } }, "/dashboards/{dashboardId}/tags" : { "put" : { "tags" : [ "dashboards" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_4", "parameters" : [ { "name" : "dashboardId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "DASHBOARDS_VIEW_AND_MANAGE" } } }, "/decrypt/support/bundle" : { "post" : { "tags" : [ "decrypt" ], "summary" : "Request download all support entities as a bundle", "operationId" : "bundleSupportEntities", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SupportListRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/octet-stream" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/decrypt/file" : { "post" : { "tags" : [ "decrypt" ], "summary" : "Request the decryption of an uploaded file", "operationId" : "decryptFile", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "data", "file", "file" ], "type" : "object", "properties" : { "file" : { "$ref" : "#/components/schemas/FormDataContentDisposition" }, "data" : { "minLength" : 1, "type" : "string" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/octet-stream" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/decrypt/object" : { "post" : { "tags" : [ "decrypt" ], "summary" : "Request the decryption of a file from object storage", "operationId" : "decryptObject", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ObjectDecryptionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/octet-stream" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/decrypt/support/list" : { "post" : { "tags" : [ "decrypt" ], "summary" : "List entities for support operations", "operationId" : "listSupportEntities", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SupportListRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/octet-stream" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/downloads/{key}" : { "get" : { "tags" : [ "downloads" ], "summary" : "Get a download cache entry and generate a token for downloading the file, expires after 5 minutes", "operationId" : "getDownload", "parameters" : [ { "name" : "key", "in" : "path", "required" : true, "schema" : { "pattern" : "[-a-f0-9]{32,36}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "downloads" ], "summary" : "Delete a download cache entry, and potentially associated data", "operationId" : "deleteDownload", "parameters" : [ { "name" : "key", "in" : "path", "required" : true, "schema" : { "pattern" : "[-a-f0-9]+", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/downloads/download/{token}" : { "get" : { "tags" : [ "downloads" ], "summary" : "Download a file", "operationId" : "download", "parameters" : [ { "name" : "token", "in" : "path", "required" : true, "schema" : { "pattern" : "[A-Za-z0-9-_.+/=]+", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/downloads" : { "get" : { "tags" : [ "downloads" ], "summary" : "Get a list of download cache entries", "operationId" : "getDownloadList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DownloadCacheEntry" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "downloads" ], "summary" : "Get header with count", "operationId" : "getDownloadHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/downloads/{token}" : { "get" : { "tags" : [ "downloads" ], "summary" : "Compatibility endpoint for file download (Deprecated: 2021-03-04)", "operationId" : "legacyDownload", "parameters" : [ { "name" : "token", "in" : "path", "required" : true, "schema" : { "pattern" : "[A-Za-z0-9-_.+/=]{37,}+", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } }, "deprecated" : true, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/engagement-requests/{engagementRequestId}/comments/{commentId}" : { "get" : { "tags" : [ "engagement-requests" ], "summary" : "Get a comment for an engagement request", "operationId" : "getCommentForEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW|ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "engagement-requests" ], "summary" : "Delete a comment for an engagement request", "operationId" : "deleteCommentForEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "engagement-requests" ], "summary" : "Partially update a comment for an engagement request", "operationId" : "patchCommentForEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } } }, "/engagement-requests/comments" : { "get" : { "tags" : [ "engagement-requests" ], "summary" : "Get comments", "operationId" : "getEngagementRequestComments", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "engagement-requests" ], "summary" : "Add a comment to one or several engagement requests", "operationId" : "postCommentForEngagementRequests", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "engagement-requests" ], "summary" : "Delete one or several comments for one or several engagement requests", "operationId" : "deleteCommentsForEngagementRequests", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "engagement-requests" ], "summary" : "Get header with count", "operationId" : "getEngagementRequestCommentCount", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/engagement-requests/{engagementRequestId}/comments" : { "get" : { "tags" : [ "engagement-requests" ], "summary" : "Get the comments for an engagement request", "operationId" : "getCommentsForEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW|ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "engagement-requests" ], "summary" : "Add a comment for an engagement request", "operationId" : "postCommentForEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } } }, "/engagement-requests/{engagementRequestId}" : { "get" : { "tags" : [ "engagement-requests" ], "summary" : "Get an engagement request", "operationId" : "getEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EngagementRequest" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW|ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "engagement-requests" ], "summary" : "Partially update an engagement request", "operationId" : "patchEngagementRequest", "parameters" : [ { "name" : "engagementRequestId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/EngagementRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } } }, "/engagement-requests" : { "get" : { "tags" : [ "engagement-requests" ], "summary" : "Get a list of engagement requests", "operationId" : "getEngagementRequests", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EngagementRequest" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW|ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "engagement-requests" ], "summary" : "Create an engagement request", "operationId" : "postEngagementRequest", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EngagementRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EngagementRequest" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "engagement-requests" ], "summary" : "Get header with count", "operationId" : "getEngagementRequestsCount", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "ENGAGEMENT_REQUESTS_VIEW|ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE" } } }, "/enroll/db-settings" : { "post" : { "tags" : [ "enroll" ], "summary" : "Configure database settings", "operationId" : "configureDatabaseSettings", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSetting" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : false, "allowedOnHiab" : true, "allowNotEnrolled" : true } }, "delete" : { "tags" : [ "enroll" ], "summary" : "Delete database settings", "operationId" : "deleteDatabaseSettings", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : false, "allowedOnHiab" : true, "allowNotEnrolled" : true } } }, "/enroll/services" : { "post" : { "tags" : [ "enroll" ], "summary" : "Enroll services", "operationId" : "enrollServices", "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/events/subscriptions/{subscriptionId}" : { "get" : { "tags" : [ "events" ], "summary" : "Get an event subscription", "operationId" : "getEventSubscription", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "events" ], "summary" : "Delete an event subscription", "operationId" : "deleteEventSubscription", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "events" ], "summary" : "Partially update an event subscription", "operationId" : "patchEventSubscription", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/events/subscriptions/{subscriptionId}/tags/{tagId}" : { "put" : { "tags" : [ "events" ], "summary" : "Create a link to a tag", "operationId" : "putEventSubscriptionTagLink", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "events" ], "summary" : "Delete a link to a tag", "operationId" : "deleteEventSubscriptionTagLink", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/events/subscriptions" : { "get" : { "tags" : [ "events" ], "summary" : "Get a list of event subscriptions", "operationId" : "getEventSubscriptionList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventSubscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "events" ], "summary" : "Create event subscription", "operationId" : "postEventSubscription", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "events" ], "summary" : "Get header with count", "operationId" : "getEventSubscriptionsHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/events/subscriptions/template-variables/{trigger}" : { "get" : { "tags" : [ "events" ], "summary" : "Get jinja variables relevant to an event", "operationId" : "getTemplateVariables", "parameters" : [ { "name" : "trigger", "in" : "path", "required" : true, "schema" : { "pattern" : "\\w+", "type" : "string", "enum" : [ "SCHEDULE_CREATED", "SCHEDULE_DELETED", "SCHEDULE_MODIFIED", "SCHEDULE_SCHEDULED", "CONFIGURATION_CREATED", "CONFIGURATION_DELETED", "CONFIGURATION_MODIFIED", "CONFIGURATION_STARTED", "CONFIGURATION_DONE", "SCAN_STARTED", "SCAN_STOPPED", "SCAN_DONE", "ASSET_NOT_RECENTLY_SEEN", "ASSET_SEEN", "ASSET_CREATED", "ASSET_DELETED", "ASSET_MODIFIED", "FINDING_SEEN", "FINDING_CREATED", "FINDING_MODIFIED", "FINDING_STATUS_TRANSITIONED", "FINDING_RISK_ACCEPTED_EXPIRATION", "WATCHED_FINDING_UPDATED", "USER_CREATED", "USER_DELETED", "USER_MODIFIED", "USER_LOGIN_ATTEMPT", "USER_PASSWORD_RESET", "ROLE_CREATED", "ROLE_DELETED", "ROLE_MODIFIED", "RESOURCE_GROUP_CREATED", "RESOURCE_GROUP_DELETED", "RESOURCE_GROUP_MODIFIED", "RELEASE_NOTES_PUBLISHED", "HIAB_SCANNER_MISSING", "HIAB_UPDATE_DONE", "HIAB_UPDATE_FAILED", "HIAB_BACKUP_DONE", "HIAB_BACKUP_FAILED", "HIAB_MAINTENANCE_PLAN_DONE", "HIAB_DISK_USAGE_HIGH", "HIAB_REBOOTED", "HIAB_REMOTE_SUPPORT", "OUTSCAN_CONSULTANCY", "CONSUMPTION_ABSOLUTE", "CONSUMPTION_RELATIVE", "WORKFLOW_CREATED", "WORKFLOW_DELETED", "WORKFLOW_MODIFIED", "WORKFLOW_STARTED", "WORKFLOW_DONE", "COMPLIANCE_CREATED", "COMPLIANCE_MODIFIED", "COMPLIANCE_RISK_EXCEPTION", "COMPLIANCE_RISK_EXCEPTION_EXPIRATION", "COMMENT_CREATED", "EXECUTIVE_SUMMARY_UPDATED", "ACTIVITY_FEED_UPDATED", "ASSET_GROUP_CREATED", "ASSET_GROUP_DELETED", "ASSET_GROUP_MODIFIED", "NEWSLETTER_PUBLISHED", "COMMERCIAL_PUBLISHED", "CUSTOMER_COMMUNICATION_PUBLISHED", "INFORMATION_PRODUCT_CREATED", "INFORMATION_PRODUCT_MODIFIED", "INFORMATION_PRODUCT_SEEN", "INFORMATION_PRODUCT_EOL", "INFORMATION_PORT_CREATED", "INFORMATION_PORT_MODIFIED", "INFORMATION_PORT_SEEN", "INFORMATION_SERVICE_CREATED", "INFORMATION_SERVICE_MODIFIED", "INFORMATION_SERVICE_SEEN", "INFORMATION_CERTIFICATE_CREATED", "INFORMATION_CERTIFICATE_MODIFIED", "INFORMATION_CERTIFICATE_SEEN", "ENGAGEMENT_REQUEST_CREATED", "ENGAGEMENT_REQUEST_MODIFIED", "MANAGED_REPORT_UPLOADED", "AUTOMATION_RULE_CREATED", "AUTOMATION_RULE_DELETED", "AUTOMATION_RULE_MODIFIED", "FINDING_SCORE_CHANGE", "CHECK_SCORE_CHANGE", "FINDING_NEW_EXPLOIT", "CHECK_NEW_EXPLOIT", "AGENT_RETIRED", "AGENT_NOT_CALLHOME", "AGENT_NOT_SCAN", "AGENT_OUTDATED" ] } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventTemplateVariable" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/events/subscriptions/{subscriptionId}/tags" : { "put" : { "tags" : [ "events" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_5", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/exploits/{exploitId}" : { "get" : { "tags" : [ "exploits" ], "summary" : "Get an exploit", "operationId" : "getExploit", "parameters" : [ { "name" : "exploitId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Exploit" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/exploits" : { "get" : { "tags" : [ "exploits" ], "summary" : "Get a list of exploits", "operationId" : "getExploitList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Exploit" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "exploits" ], "summary" : "Get header with count", "operationId" : "getExploitHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/finding-template-groups/{findingTemplateGroupId}" : { "get" : { "tags" : [ "finding-template-groups" ], "summary" : "Get a finding template group", "operationId" : "getFindingTemplateGroup", "parameters" : [ { "name" : "findingTemplateGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplateGroup" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "finding-template-groups" ], "summary" : "Delete a finding template group", "operationId" : "deleteFindingTemplateGroup", "parameters" : [ { "name" : "findingTemplateGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-template-groups" : { "get" : { "tags" : [ "finding-template-groups" ], "summary" : "Get a list of finding template groups", "operationId" : "getFindingTemplateGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FindingTemplateGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "finding-template-groups" ], "summary" : "Create a finding template group", "operationId" : "postFindingTemplateGroup", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplateGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "finding-template-groups" ], "summary" : "Get header with count", "operationId" : "getFindingTemplateGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-template-groups/{findingTemplateId}" : { "patch" : { "tags" : [ "finding-template-groups" ], "summary" : "Update a finding template", "operationId" : "patchFindingTemplateGroup", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplateGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-templates/{findingTemplateId}" : { "get" : { "tags" : [ "finding-templates" ], "summary" : "Get a finding template", "operationId" : "getFindingTemplate", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplate" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "finding-templates" ], "summary" : "Delete a finding template", "operationId" : "deleteFindingTemplate", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "finding-templates" ], "summary" : "Update a finding template", "operationId" : "patchFindingTemplate", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-templates/{findingTemplateId}/tags/{tagId}" : { "put" : { "tags" : [ "finding-templates" ], "summary" : "Create a link to a tag", "operationId" : "putFindingTemplateTagLink", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "finding-templates" ], "summary" : "Delete a link to a tag", "operationId" : "deleteFindingTemplateTagLink", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-templates" : { "get" : { "tags" : [ "finding-templates" ], "summary" : "Get a list of finding templates", "operationId" : "getFindingTemplateList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FindingTemplate" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "finding-templates" ], "summary" : "Create a finding template", "operationId" : "postFindingTemplate", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "finding-templates" ], "summary" : "Get header with count", "operationId" : "getFindingTemplateHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW|FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/finding-templates/{findingTemplateId}/tags" : { "put" : { "tags" : [ "finding-templates" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_6", "parameters" : [ { "name" : "findingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDING_TEMPLATES_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/clone/assets/{assetId}" : { "post" : { "tags" : [ "findings" ], "summary" : "Clone a finding and link it to a given asset", "operationId" : "cloneFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/comment-fixed" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as fixed with optional comment", "operationId" : "commentFixedForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FIXED" } } }, "/findings/comment-fixed" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several findings as fixed with optional shared comment", "operationId" : "commentFixedForFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FIXED" } } }, "/findings/{findingId}/comment-irreproducible" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as irreproducible with optional comment", "operationId" : "commentIrreproducible", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/comment-irreproducible" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several findings as irreproducible with optional shared comment", "operationId" : "commentIrreproducibleBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/comment-reset-status" : { "post" : { "tags" : [ "findings" ], "summary" : "Reset status of finding to 'PRESENT' with optional comment", "operationId" : "commentResetFindingStatus", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/comment-reset-status" : { "post" : { "tags" : [ "findings" ], "summary" : "Reset status on one or several findings to 'PRESENT", "operationId" : "commentResetFindingsStatus", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingStatusTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/attachments/{attachmentId}" : { "get" : { "tags" : [ "findings" ], "summary" : "Get an attachment for a finding", "operationId" : "getAttachmentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Attachment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete an attachment for a finding", "operationId" : "deleteAttachmentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/comments/{commentId}" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a comment for a finding", "operationId" : "getCommentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete a comment for a finding", "operationId" : "deleteCommentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } }, "patch" : { "tags" : [ "findings" ], "summary" : "Partially update a comment for a finding", "operationId" : "patchCommentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/findings/comments" : { "get" : { "tags" : [ "findings" ], "summary" : "Get comments", "operationId" : "getCommentList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "findings" ], "summary" : "Add a comment to one or several findings", "operationId" : "postCommentForFindings", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete one or several comments for one or several findings", "operationId" : "deleteCommentsForFinding", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } }, "head" : { "tags" : [ "findings" ], "summary" : "Get header with count", "operationId" : "getCommentCount", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/findings/{findingId}" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a finding by ID", "operationId" : "getFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Finding" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete a finding", "operationId" : "deleteFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "findings" ], "summary" : "Partially update a finding", "operationId" : "patchFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Finding" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE|FINDINGS_CHANGE_RISK" } } }, "/findings/{findingId}/tags/{tagId}" : { "put" : { "tags" : [ "findings" ], "summary" : "Create a link to a tag", "operationId" : "putFindingTagLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete a link to a tag", "operationId" : "deleteFindingTagLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/findings/tags/{tagId}" : { "put" : { "tags" : [ "findings" ], "summary" : "Create links to a tag", "operationId" : "putFindingTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete links to a tag", "operationId" : "deleteFindingTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/findings" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a list of findings", "operationId" : "getFindingList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Finding" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "findings" ], "summary" : "Create a finding", "operationId" : "postFinding", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Finding" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete one or several findings", "operationId" : "deleteFindings", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "findings" ], "summary" : "Get header with count", "operationId" : "getFindingHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "findings" ], "summary" : "Partially update one or several findings", "operationId" : "patchFindings", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Finding" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE|FINDINGS_CHANGE_RISK" } } }, "/findings/{findingId}/matches/{matchId}" : { "put" : { "tags" : [ "findings" ], "summary" : "Create a link to a match", "operationId" : "putMatchLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "matchId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "findings" ], "summary" : "Delete a link to a match", "operationId" : "deleteMatchLink", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "matchId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/attachments/{attachmentId}/download" : { "get" : { "tags" : [ "findings" ], "summary" : "Get the token for downloading an attachment for a finding", "operationId" : "downloadAttachmentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/send" : { "post" : { "tags" : [ "findings" ], "summary" : "Send finding as email", "operationId" : "exportFindingAsEmail", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingExportAsEmail" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/attachments" : { "get" : { "tags" : [ "findings" ], "summary" : "Get the attachments for a finding", "operationId" : "getAttachmentListForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Attachment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "findings" ], "summary" : "Add an attachment for a finding", "operationId" : "postAttachmentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "OTHER", "IMAGE", "TEXT", "VIDEO", "ARCHIVE" ] }, "file" : { "$ref" : "#/components/schemas/FormDataContentDisposition" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/comments" : { "get" : { "tags" : [ "findings" ], "summary" : "Get the comments for a finding", "operationId" : "getCommentListForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "findings" ], "summary" : "Add a comment for a finding", "operationId" : "postCommentForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/findings/{findingId}/exploits" : { "get" : { "tags" : [ "findings" ], "summary" : "Get the exploits for a finding (Deprecated: 2026-05-25)", "operationId" : "getExploitListForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "deprecated" : true, "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Exploit" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/delta" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a list of deltas", "operationId" : "getFindingDeltaList", "parameters" : [ { "name" : "from", "in" : "query", "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "to", "in" : "query", "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "findingFilter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FindingDelta" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/delta-summary" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a delta summary", "operationId" : "getFindingDeltaSummary", "parameters" : [ { "name" : "from", "in" : "query", "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "to", "in" : "query", "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "findingFilter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingDelta" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/solutions" : { "get" : { "tags" : [ "findings" ], "summary" : "Get a list of solutions", "operationId" : "getFindingSolutionList", "parameters" : [ { "name" : "assetIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "assetGroupIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "findingFilter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FindingSolution" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/secure-code-warrior" : { "post" : { "tags" : [ "findings" ], "summary" : "Log the request to Secure Code Warrior", "operationId" : "logSecureCodeWarriorRequestForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/mark-false-positive" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as false positive", "operationId" : "markFalsePositiveForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingFalsePositive" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FALSE_POSITIVE" } } }, "/findings/mark-false-positive" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several finding(s) as false positives", "operationId" : "markFalsePositiveForFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingFalsePositive" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FALSE_POSITIVE" } } }, "/findings/{findingId}/mark-fixed" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as fixed (Deprecated 2026-01-13)", "operationId" : "markFixedForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FIXED" } } }, "/findings/mark-fixed" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several findings as fixed (Deprecated 2026-01-13)", "operationId" : "markFixedForFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FIXED" } } }, "/findings/{findingId}/mark-irreproducible" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as irreproducible (Deprecated 2026-01-13)", "operationId" : "markIrreproducible", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/mark-irreproducible" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several findings as irreproducible (Deprecated 2026-01-13)", "operationId" : "markIrreproducibleBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/tags" : { "put" : { "tags" : [ "findings" ], "summary" : "Modify linked set of tags", "operationId" : "modifyFindingTagLinks", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/findings/tags" : { "put" : { "tags" : [ "findings" ], "summary" : "Modify linked set of tags to one or several findings", "operationId" : "modifyFindingsTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/findings/{findingId}/publish" : { "post" : { "tags" : [ "findings" ], "summary" : "Publish finding (set as present)", "operationId" : "publishFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/publish" : { "post" : { "tags" : [ "findings" ], "summary" : "Publish findings (set as present)", "operationId" : "publishFindingBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/reject" : { "post" : { "tags" : [ "findings" ], "summary" : "Set finding as rejected", "operationId" : "rejectFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/reject" : { "post" : { "tags" : [ "findings" ], "summary" : "Set finding as rejected", "operationId" : "rejectFindingBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/request-clarification" : { "post" : { "tags" : [ "findings" ], "summary" : "Request clarification for a finding", "operationId" : "requestClarificationForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingClarificationRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/findings/{findingId}/request-verification" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark finding as pending verification", "operationId" : "requestVerificationForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingVerificationRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_REQUEST_VERIFICATION" } } }, "/findings/request-verification" : { "post" : { "tags" : [ "findings" ], "summary" : "Mark one or several findings as pending for verification", "operationId" : "requestVerificationForFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingVerificationRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_REQUEST_VERIFICATION" } } }, "/findings/{findingId}/reset-status" : { "post" : { "tags" : [ "findings" ], "summary" : "Reset status of finding to 'PRESENT' (Deprecated 2026-01-13)", "operationId" : "resetFindingStatus", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/reset-status" : { "post" : { "tags" : [ "findings" ], "summary" : "Reset status on one or several findings to 'PRESENT' (Deprecated: 2025-11-25)", "operationId" : "resetFindingsStatus", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/accept" : { "post" : { "tags" : [ "findings" ], "summary" : "Accept finding", "operationId" : "setAcceptedForFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingAccept" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_ACCEPT_RISK" } } }, "/findings/accept" : { "post" : { "tags" : [ "findings" ], "summary" : "Accept one or several findings", "operationId" : "setAcceptedForFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FindingAccept" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_ACCEPT_RISK" } } }, "/findings/{findingId}/quality-assure" : { "post" : { "tags" : [ "findings" ], "summary" : "Set finding as quality assured", "operationId" : "setQualityAssured", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/quality-assure" : { "post" : { "tags" : [ "findings" ], "summary" : "Set findings as quality assured and transition to be published", "operationId" : "setQualityAssuredBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/review" : { "post" : { "tags" : [ "findings" ], "summary" : "Set finding as reviewed and transition to be verified", "operationId" : "setReviewed", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/review" : { "post" : { "tags" : [ "findings" ], "summary" : "Set findings as reviewed and transition to be verified", "operationId" : "setReviewedBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/verify" : { "post" : { "tags" : [ "findings" ], "summary" : "Set finding as verified and transitioned to be quality assured", "operationId" : "setVerified", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/verify" : { "post" : { "tags" : [ "findings" ], "summary" : "Set findings as verified and transition to be quality assured", "operationId" : "setVerifiedBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/unwatch" : { "post" : { "tags" : [ "findings" ], "summary" : "Unwatch a finding", "operationId" : "unwatchFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/unwatch" : { "post" : { "tags" : [ "findings" ], "summary" : "Unwatch one or several findings", "operationId" : "unwatchFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/{findingId}/watch" : { "post" : { "tags" : [ "findings" ], "summary" : "Watch a finding", "operationId" : "watchFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/findings/watch" : { "post" : { "tags" : [ "findings" ], "summary" : "Watch one or several findings", "operationId" : "watchFindings", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/globals" : { "get" : { "tags" : [ "globals" ], "summary" : "Get global settings", "operationId" : "getGlobals", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Globals" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/globals/timezones" : { "get" : { "tags" : [ "globals" ], "summary" : "Get a list of timezones", "operationId" : "getTimezones", "parameters" : [ { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Timezone" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/information/{informationId}/comments/{commentId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get a comment for information", "operationId" : "getCommentForInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "information" ], "summary" : "Delete a comment for information", "operationId" : "deleteCommentForInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/information/comments" : { "post" : { "tags" : [ "information" ], "summary" : "Add a comment to one or several information", "operationId" : "postCommentForInformationBulk", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } }, "delete" : { "tags" : [ "information" ], "summary" : "Delete one or several comments for one or several information", "operationId" : "deleteCommentsForInformation", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/information/{informationId}/tags/{tagId}" : { "put" : { "tags" : [ "information" ], "summary" : "Create a link to a tag", "operationId" : "putInformationTagLink", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } }, "delete" : { "tags" : [ "information" ], "summary" : "Delete a link to a tag", "operationId" : "deleteInformationTagLink", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/information/tags/{tagId}" : { "put" : { "tags" : [ "information" ], "summary" : "Create links to a tag", "operationId" : "putInformationTagLinksBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } }, "delete" : { "tags" : [ "information" ], "summary" : "Delete links to a tag", "operationId" : "deleteInformationTagLinksBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/information/certificates/{informationId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get information for certificates by ID", "operationId" : "getCertificateInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Information" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/certificates" : { "get" : { "tags" : [ "information" ], "summary" : "Get a list of information for certificates", "operationId" : "getCertificateInformationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Information" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "information" ], "summary" : "Get header with count for certificates", "operationId" : "getCertificateInformationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/{informationId}/comments" : { "get" : { "tags" : [ "information" ], "summary" : "Get the comments for information", "operationId" : "getCommentListForInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "information" ], "summary" : "Add a comment for information", "operationId" : "postCommentForInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/information/{informationId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get information by ID", "operationId" : "getInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Information" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information" : { "get" : { "tags" : [ "information" ], "summary" : "Get a list of information", "operationId" : "getInformationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Information" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "information" ], "summary" : "Get header with count", "operationId" : "getInformationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/ports/{informationId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get information for port by ID", "operationId" : "getPortInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Information" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/ports" : { "get" : { "tags" : [ "information" ], "summary" : "Get a list of information for ports", "operationId" : "getPortInformationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Information" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "information" ], "summary" : "Get header with count for ports", "operationId" : "getPortInformationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/products/{informationId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get information for product by ID", "operationId" : "getProductInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Information" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/products" : { "get" : { "tags" : [ "information" ], "summary" : "Get a list of information for products", "operationId" : "getProductInformationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Information" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "information" ], "summary" : "Get header with count for products", "operationId" : "getProductInformationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/services/{informationId}" : { "get" : { "tags" : [ "information" ], "summary" : "Get information for service by ID", "operationId" : "getServiceInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Information" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/services" : { "get" : { "tags" : [ "information" ], "summary" : "Get a list of information for services", "operationId" : "getServiceInformationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Information" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "information" ], "summary" : "Get header with count for services", "operationId" : "getServiceInformationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } } }, "/information/{informationId}/mark-false-positive" : { "post" : { "tags" : [ "information" ], "summary" : "Mark information as false positive", "operationId" : "markFalsePositiveForInformation", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InformationFalsePositive" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FALSE_POSITIVE" } } }, "/information/mark-false-positive" : { "post" : { "tags" : [ "information" ], "summary" : "Mark one or several information as false positives", "operationId" : "markFalsePositiveForInformationBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InformationFalsePositive" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MARK_AS_FALSE_POSITIVE" } } }, "/information/{informationId}/tags" : { "put" : { "tags" : [ "information" ], "summary" : "Modify linked set of tags", "operationId" : "modifyInformationTagLinks", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/information/tags" : { "put" : { "tags" : [ "information" ], "summary" : "Modify linked set of tags to one or several information", "operationId" : "modifyInformationTagLinksBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_MANAGE_TAGS" } } }, "/information/{informationId}/reset-status" : { "post" : { "tags" : [ "information" ], "summary" : "Reset status of information to 'PRESENT'", "operationId" : "resetInformationStatus", "parameters" : [ { "name" : "informationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/information/reset-status" : { "post" : { "tags" : [ "information" ], "summary" : "Reset status on one or several information to 'PRESENT", "operationId" : "resetInformationStatusBulk", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE" } } }, "/integrations/authorization" : { "get" : { "tags" : [ "integrations" ], "summary" : "Authorization", "operationId" : "authorization", "parameters" : [ { "name" : "code", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "error", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "error_description", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "state", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/{integrationId}/authorize" : { "get" : { "tags" : [ "integrations" ], "summary" : "Authorize an integration based on OAuth 2.0", "operationId" : "authorize", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/{integrationId}" : { "get" : { "tags" : [ "integrations" ], "summary" : "Get an integration", "operationId" : "getIntegration", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW|INTEGRATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "integrations" ], "summary" : "Delete an integration", "operationId" : "deleteIntegration", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "integrations" ], "summary" : "Partially update an integration", "operationId" : "patchIntegration", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Integration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/{integrationId}/tags/{tagId}" : { "put" : { "tags" : [ "integrations" ], "summary" : "Create a link to a tag", "operationId" : "putIntegrationTagLink", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "integrations" ], "summary" : "Delete a link to a tag", "operationId" : "deleteIntegrationTagLink", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations" : { "get" : { "tags" : [ "integrations" ], "summary" : "Get a list of integrations", "operationId" : "getIntegrationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Integration" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW|INTEGRATIONS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "integrations" ], "summary" : "Create an integration", "operationId" : "postIntegration", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "integrations" ], "summary" : "Get header with count", "operationId" : "getIntegrationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW|INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/{integrationId}/tags" : { "put" : { "tags" : [ "integrations" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_7", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/verify" : { "post" : { "tags" : [ "integrations" ], "summary" : "Verify the integration connectivity", "operationId" : "verifyIntegration", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Integration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/integrations/{integrationId}/verify" : { "post" : { "tags" : [ "integrations" ], "summary" : "Verify the integration connectivity", "operationId" : "verifyIntegration_1", "parameters" : [ { "name" : "integrationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "INTEGRATIONS_VIEW_AND_MANAGE" } } }, "/managed-report-groups/{managedReportGroupId}" : { "get" : { "tags" : [ "managed-report-groups" ], "summary" : "Get a managed report group (Deprecated: 2019-12-11)", "operationId" : "getManagedReportGroup", "parameters" : [ { "name" : "managedReportGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ManagedReportGroup" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/managed-report-groups" : { "get" : { "tags" : [ "managed-report-groups" ], "summary" : "Get a list of managed report groups (Deprecated: 2019-12-11)", "operationId" : "getManagedReportGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ManagedReportGroup" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "managed-report-groups" ], "summary" : "Get header with count (Deprecated: 2019-12-11)", "operationId" : "getManagedReportGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/managed-reports/{managedReportId}" : { "get" : { "tags" : [ "managed-reports" ], "summary" : "Get a managed report", "operationId" : "getManagedReport", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ManagedReport" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW|MANAGED_REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "managed-reports" ], "summary" : "Delete a managed report", "operationId" : "deleteManagedReport", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "managed-reports" ], "summary" : "Partially update a managed report", "operationId" : "patchManagedReport", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ManagedReport" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports/{managedReportId}/tags/{tagId}" : { "put" : { "tags" : [ "managed-reports" ], "summary" : "Create a link to a tag", "operationId" : "putManagedReportTagLink", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "managed-reports" ], "summary" : "Delete a link to a tag", "operationId" : "deleteManagedReportTagLink", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports/{managedReportId}/download" : { "get" : { "tags" : [ "managed-reports" ], "summary" : "Get the token for downloading a managed report", "operationId" : "downloadManagedReport", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW|MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports" : { "get" : { "tags" : [ "managed-reports" ], "summary" : "Get a list of managed reports", "operationId" : "getManagedReportList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ManagedReport" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW|MANAGED_REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "managed-reports" ], "summary" : "Create a managed report", "operationId" : "postManagedReport", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "file" : { "$ref" : "#/components/schemas/FormDataContentDisposition" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "managed-reports" ], "summary" : "Get header with count", "operationId" : "getManagedReportHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW|MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports/tags" : { "get" : { "tags" : [ "managed-reports" ], "summary" : "Get a list of tags for managed reports", "operationId" : "getManagedReportTags", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW|MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports/{managedReportId}/tags" : { "put" : { "tags" : [ "managed-reports" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_8", "parameters" : [ { "name" : "managedReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "MANAGED_REPORTS_VIEW_AND_MANAGE" } } }, "/managed-reports/upload" : { "post" : { "tags" : [ "managed-reports" ], "summary" : "Upload a managed report from HIAB", "operationId" : "uploadManagedReport", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "name" : { "type" : "string" }, "tags" : { "type" : "string" }, "file" : { "$ref" : "#/components/schemas/FormDataContentDisposition" } } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/matches/{matchId}" : { "get" : { "tags" : [ "matches" ], "summary" : "Get a match", "operationId" : "getMatch", "parameters" : [ { "name" : "matchId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Match" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "matches" ], "summary" : "Delete a match", "operationId" : "deleteMatch", "parameters" : [ { "name" : "matchId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "matches" ], "summary" : "Partially update a match", "operationId" : "patchMatch", "parameters" : [ { "name" : "matchId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Match" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/matches" : { "get" : { "tags" : [ "matches" ], "summary" : "Get a list of matches", "operationId" : "getMatchList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Match" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "matches" ], "summary" : "Create a match", "operationId" : "postMatch", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Match" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "matches" ], "summary" : "Get header with count", "operationId" : "getMatchHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE|COMPLIANCE_VIEW|COMPLIANCE_VIEW_AND_MANAGE" } } }, "/notifications/{notificationId}" : { "get" : { "tags" : [ "notifications" ], "summary" : "Get a notification", "operationId" : "getNotification", "parameters" : [ { "name" : "notificationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Notification" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/notifications" : { "get" : { "tags" : [ "notifications" ], "summary" : "Get a list of notifications", "operationId" : "getNotificationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Notification" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "notifications" ], "summary" : "Get header with count", "operationId" : "getNotificationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/notifications/{notificationId}/mark-as-read" : { "post" : { "tags" : [ "notifications" ], "summary" : "Mark a notification as read", "operationId" : "markNotificationAsRead", "parameters" : [ { "name" : "notificationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/notifications/{notificationId}/mark-as-unread" : { "post" : { "tags" : [ "notifications" ], "summary" : "Mark a notification as unread", "operationId" : "markNotificationAsUnread", "parameters" : [ { "name" : "notificationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/organizations/{organizationId}" : { "get" : { "tags" : [ "organizations" ], "summary" : "Get an organization", "operationId" : "getOrganization", "parameters" : [ { "name" : "organizationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Organization" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/organizations" : { "get" : { "tags" : [ "organizations" ], "summary" : "Get a list of organizations", "operationId" : "getOrganizationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Organization" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "organizations" ], "summary" : "Get header with count", "operationId" : "getOrganizationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/outscan/findings/{findingId}/exploits" : { "get" : { "tags" : [ "outscan-findings" ], "summary" : "Get the exploits for a finding", "operationId" : "getExploitListForOutscanFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Exploit" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/findings/{findingId}" : { "get" : { "tags" : [ "outscan-findings" ], "summary" : "Get a finding by ID", "operationId" : "getOutscanFinding", "parameters" : [ { "name" : "findingId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanFinding" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/findings" : { "get" : { "tags" : [ "outscan-findings" ], "summary" : "Get a list of findings", "operationId" : "getOutscanFindingList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanFinding" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "outscan-findings" ], "summary" : "Get header with count", "operationId" : "getOutscanFindingHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scan-logs/{scanLogId}/findings" : { "get" : { "tags" : [ "outscan-scan-logs" ], "summary" : "Get a list of findings for a scan", "operationId" : "getFindingListScanLog", "parameters" : [ { "name" : "scanLogId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanFinding" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scan-logs/{scanLogId}" : { "get" : { "tags" : [ "outscan-scan-logs" ], "summary" : "Get a scan log", "operationId" : "getScanLog", "parameters" : [ { "name" : "scanLogId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanScanLog" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scan-logs" : { "get" : { "tags" : [ "outscan-scan-logs" ], "summary" : "Get a list of scan logs", "operationId" : "getScanLogList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanScanLog" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "outscan-scan-logs" ], "summary" : "Get header with count", "operationId" : "getScanLogHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scans/{scanId}" : { "get" : { "tags" : [ "outscan-scans" ], "summary" : "Get a scan", "operationId" : "getOutscanScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanScan" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scans" : { "get" : { "tags" : [ "outscan-scans" ], "summary" : "Get a list of scans", "operationId" : "getOutscanScanList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanScan" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "outscan-scans" ], "summary" : "Get header with count", "operationId" : "getOutscanScanHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/scans/{scanId}/stop" : { "post" : { "tags" : [ "outscan-scans" ], "summary" : "Stop a scan", "operationId" : "stopOutscanScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/schedules/{scheduleId}" : { "get" : { "tags" : [ "outscan-schedules" ], "summary" : "Get a schedule", "operationId" : "getOutscanSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanSchedule" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "outscan-schedules" ], "summary" : "Delete a schedule", "operationId" : "deleteOutscanSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "outscan-schedules" ], "summary" : "Partially update a schedule", "operationId" : "patchOutscanSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/OutscanSchedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/schedules" : { "get" : { "tags" : [ "outscan-schedules" ], "summary" : "Get a list of schedules", "operationId" : "getOutscanScheduleList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanSchedule" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "outscan-schedules" ], "summary" : "Create a schedule", "operationId" : "postOutscanSchedule", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanSchedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "outscan-schedules" ], "summary" : "Get header with count", "operationId" : "getOutscanScheduleHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/schedules/{scheduleId}/scan" : { "post" : { "tags" : [ "outscan-schedules" ], "summary" : "Start scanning now", "operationId" : "scanOutscanSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/targets/{targetId}" : { "get" : { "tags" : [ "outscan-targets" ], "summary" : "Get a target", "operationId" : "getTarget", "parameters" : [ { "name" : "targetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OutscanTarget" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "outscan-targets" ], "summary" : "Delete a target", "operationId" : "deleteTarget", "parameters" : [ { "name" : "targetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/outscan/targets" : { "get" : { "tags" : [ "outscan-targets" ], "summary" : "Get a list of targets", "operationId" : "getTargetList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OutscanTarget" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "outscan-targets" ], "summary" : "Create new targets", "operationId" : "postTargets", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "outscan-targets" ], "summary" : "Get header with count", "operationId" : "getTargetHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/password-recovery" : { "post" : { "tags" : [ "password-recovery" ], "summary" : "Request password recovery email for username", "operationId" : "passwordRecovery", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordRecoveryRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/product-information/{productInformationId}/comments/{commentId}" : { "get" : { "tags" : [ "product-information" ], "summary" : "Get a comment for a product", "operationId" : "getCommentForProductInformation", "parameters" : [ { "name" : "productInformationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "product-information" ], "summary" : "Delete a comment for a product", "operationId" : "deleteCommentForProductInformation", "parameters" : [ { "name" : "productInformationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "commentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_COMMENT" } } }, "/product-information/{productInformationId}/comments" : { "get" : { "tags" : [ "product-information" ], "summary" : "Get the comments for a product", "operationId" : "getCommentListForProductInformation", "parameters" : [ { "name" : "productInformationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "FINDINGS_VIEW|FINDINGS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "product-information" ], "summary" : "Add a comment for a product", "operationId" : "postCommentForProductInformation", "parameters" : [ { "name" : "productInformationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/product-information/{productInformationId}" : { "get" : { "tags" : [ "product-information" ], "summary" : "Get a products", "operationId" : "getProductInformation_1", "parameters" : [ { "name" : "productInformationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductInformation" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/product-information" : { "get" : { "tags" : [ "product-information" ], "summary" : "Get a list of products", "operationId" : "getProductInformationList_1", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProductInformation" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "product-information" ], "summary" : "Get header with count", "operationId" : "getProductInformationHeader_1", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/release-notes/notification-trigger" : { "get" : { "tags" : [ "release-notes" ], "summary" : "Get last release notes notification trigger timestamp (Deprecated: 2025-06-24)", "operationId" : "getLastTriggerTimestamp", "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|releasemanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/release-notes/trigger-notification" : { "post" : { "tags" : [ "release-notes" ], "summary" : "Trigger release notes notification and set trigger timestamp (Deprecated: 2025-06-24)", "operationId" : "triggerReleaseNotesNotification", "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|releasemanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/report-schedules/{reportScheduleId}" : { "get" : { "tags" : [ "report-schedules" ], "summary" : "Get a report schedule (Deprecated: 2019-12-11)", "operationId" : "getReportSchedule", "parameters" : [ { "name" : "reportScheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportSchedule" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "report-schedules" ], "summary" : "Delete a report schedule (Deprecated: 2019-12-11)", "operationId" : "deleteReportSchedule", "parameters" : [ { "name" : "reportScheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "report-schedules" ], "summary" : "Partially update a report schedule (Deprecated: 2019-12-11)", "operationId" : "patchReportSchedule", "parameters" : [ { "name" : "reportScheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSchedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/report-schedules" : { "get" : { "tags" : [ "report-schedules" ], "summary" : "Get a list of report schedules (Deprecated: 2019-12-11)", "operationId" : "getReportScheduleList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportSchedule" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "report-schedules" ], "summary" : "Create a new report schedule (Deprecated: 2019-12-11)", "operationId" : "postReportSchedule", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportSchedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "report-schedules" ], "summary" : "Get header with count (Deprecated: 2019-12-11)", "operationId" : "getReportScheduleHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/report-schedules/{reportScheduleId}/send" : { "post" : { "tags" : [ "report-schedules" ], "summary" : "Start scanning now (Deprecated: 2019-12-11)", "operationId" : "sendReportSchedule", "parameters" : [ { "name" : "reportScheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/reports/{key}" : { "get" : { "tags" : [ "reports" ], "summary" : "Get a report cache entry and generate a token for downloading the report, expires after 5 minutes (Deprecated: 2021-02-25)", "operationId" : "getReport", "parameters" : [ { "name" : "key", "in" : "path", "required" : true, "schema" : { "pattern" : "[-a-f0-9]+", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "reports" ], "summary" : "Delete a report (Deprecated: 2021-02-25)", "operationId" : "deleteReport", "parameters" : [ { "name" : "key", "in" : "path", "required" : true, "schema" : { "pattern" : "[-a-f0-9]+", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } } }, "/reports" : { "get" : { "tags" : [ "reports" ], "summary" : "Get a list of report cache entries (Deprecated: 2021-02-25)", "operationId" : "getReportList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportCacheEntry" } } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "reports" ], "summary" : "Generate a report", "operationId" : "requestReport", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "reports" ], "summary" : "Get header with count (Deprecated: 2021-02-25)", "operationId" : "getReportHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "deprecated" : true, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "REPORTS_VIEW_AND_MANAGE" } } }, "/resource-groups/{resourceGroupId}" : { "get" : { "tags" : [ "resource-groups" ], "summary" : "Get a resource group", "operationId" : "getResourceGroup", "parameters" : [ { "name" : "resourceGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceGroup" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "resource-groups" ], "summary" : "Delete a resource group", "operationId" : "deleteResourceGroup", "parameters" : [ { "name" : "resourceGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "resource-groups" ], "summary" : "Partially update a resource group", "operationId" : "patchResourceGroup", "parameters" : [ { "name" : "resourceGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ResourceGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/resource-groups" : { "get" : { "tags" : [ "resource-groups" ], "summary" : "Get a list of resource groups", "operationId" : "getResourceGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "resource-groups" ], "summary" : "Create a resource group", "operationId" : "postResourceGroup", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "resource-groups" ], "summary" : "Get header with count", "operationId" : "getResourceGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/rule-engine" : { "post" : { "tags" : [ "rule-engine" ], "summary" : "Run rule engine", "operationId" : "runRuleEngine", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PatternMatch" } } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Finding" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/scan-configuration-groups/{scanConfigurationGroupId}" : { "get" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Get scan configuration group", "operationId" : "getScanConfigurationGroup", "parameters" : [ { "name" : "scanConfigurationGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfigurationGroup" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Delete scan configuration group", "operationId" : "deleteScanConfigurationGroup", "parameters" : [ { "name" : "scanConfigurationGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Partially update a scan configuration group", "operationId" : "patchScanConfigurationGroup", "parameters" : [ { "name" : "scanConfigurationGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfigurationGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/scan-configuration-groups" : { "get" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Get a list of scan configuration groups", "operationId" : "getScanConfigurationGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScanConfigurationGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Create a scan configuration group", "operationId" : "postScanConfigurationGroup", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfigurationGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "scan-configuration-groups" ], "summary" : "Get header with count", "operationId" : "getScanConfigurationGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/scan-configurations/{scanConfigurationId}/asset-identifiers/{assetIdentifierId}" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Create a link to an asset identifier", "operationId" : "putAssetIdentifierLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a link to an asset identifier", "operationId" : "deleteAssetIdentifierLink_1", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetIdentifierId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/assets/{assetId}" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Create a link to an asset", "operationId" : "putAssetLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a link to an asset", "operationId" : "deleteAssetLink_1", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}" : { "get" : { "tags" : [ "scan-configurations" ], "summary" : "Get a scan configuration", "operationId" : "getScanConfiguration", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfiguration" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a scan configuration", "operationId" : "deleteScanConfiguration", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "scan-configurations" ], "summary" : "Partially update a scan configuration", "operationId" : "patchScanConfiguration", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfiguration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/schedules/{scheduleId}" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Create a link to a schedule", "operationId" : "putScanConfigurationScheduleLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a link to a schedule", "operationId" : "deleteScanConfigurationScheduleLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/tags/{tagId}" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Create a link to a tag", "operationId" : "putScanConfigurationTagLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a link to a tag", "operationId" : "deleteScanConfigurationTagLink", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/tags/{tagId}" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Create a tag link to one or several scan configurations", "operationId" : "putScanConfigurationTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete a tag link to one or several scan configurations", "operationId" : "deleteScanConfigurationTagLinks", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations" : { "get" : { "tags" : [ "scan-configurations" ], "summary" : "Get a list of scan configurations", "operationId" : "getScanConfigurationList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScanConfiguration" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "scan-configurations" ], "summary" : "Create a scan configuration", "operationId" : "postScanConfiguration", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfiguration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-configurations" ], "summary" : "Delete one or several scan configurations", "operationId" : "deleteScanConfigurations", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "scan-configurations" ], "summary" : "Get header with count", "operationId" : "getScanConfigurationHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "scan-configurations" ], "summary" : "Partially update one or several scan configurations", "operationId" : "patchScanConfigurations", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ScanConfiguration" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/tags" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Modify linked set of tags", "operationId" : "modifyScanConfigurationTagLinks", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/tags" : { "put" : { "tags" : [ "scan-configurations" ], "summary" : "Modify linked set of tags to several scan configurations", "operationId" : "modifyScanConfigurationsTagLinks", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/scan" : { "post" : { "tags" : [ "scan-configurations" ], "summary" : "Start a scan based on this configuration", "operationId" : "scanSchedule", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW_AND_MANAGE" } } }, "/scan-configurations/{scanConfigurationId}/test-playwright-script" : { "post" : { "tags" : [ "scan-configurations" ], "summary" : "Test an application setup Playwright script", "operationId" : "testPlaywrightScriptForScanConfiguration", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-configurations/test-setup-script" : { "post" : { "tags" : [ "scan-configurations" ], "summary" : "Test a setup LUA script", "operationId" : "testSetupScript", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSetupScript" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/scan-configurations/{scanConfigurationId}/test-setup-script" : { "post" : { "tags" : [ "scan-configurations" ], "summary" : "Test an application setup LUA script", "operationId" : "testSetupScriptForScanConfiguration", "parameters" : [ { "name" : "scanConfigurationId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/scan-policies/{scanPolicyId}" : { "get" : { "tags" : [ "scan-policies" ], "summary" : "Get a scan policy", "operationId" : "getScanPolicy", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanPolicy" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW|SCAN_POLICIES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-policies" ], "summary" : "Delete a scan policy", "operationId" : "deleteScanPolicy", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "scan-policies" ], "summary" : "Partially update an scan policy", "operationId" : "patchScanPolicy", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ScanPolicy" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies/{scanPolicyId}/accounts/{accountId}" : { "put" : { "tags" : [ "scan-policies" ], "summary" : "Create a link to an account", "operationId" : "putScanPolicyAccountLink", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-policies" ], "summary" : "Delete a link to an account", "operationId" : "deleteScanPolicyAccountLink", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "accountId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies/{scanPolicyId}/tags/{tagId}" : { "put" : { "tags" : [ "scan-policies" ], "summary" : "Create a link to a tag", "operationId" : "putScanPolicyTagLink", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scan-policies" ], "summary" : "Delete a link to a tag", "operationId" : "deleteScanPolicyTagLink", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies/default-settings" : { "get" : { "tags" : [ "scan-policies" ], "summary" : "Get default scan policy settings", "operationId" : "getDefaultScanPolicySettings", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanPolicySettings" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW|SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies" : { "get" : { "tags" : [ "scan-policies" ], "summary" : "Get a list of scan policies", "operationId" : "getScanPolicyList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScanPolicy" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW|SCAN_POLICIES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "scan-policies" ], "summary" : "Create a scan policy", "operationId" : "postScanPolicy", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanPolicy" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "scan-policies" ], "summary" : "Get header with count", "operationId" : "getScanPolicyHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW|SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies/{scanPolicyId}/tags" : { "put" : { "tags" : [ "scan-policies" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_9", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scan-policies/{scanPolicyId}/accounts" : { "put" : { "tags" : [ "scan-policies" ], "summary" : "Modify linked set of account IDs", "operationId" : "putScanPolicyAccountIds", "parameters" : [ { "name" : "scanPolicyId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_POLICIES_VIEW_AND_MANAGE" } } }, "/scanners/{scannerId}" : { "get" : { "tags" : [ "scanners" ], "summary" : "Get a scanner", "operationId" : "getScanner", "parameters" : [ { "name" : "scannerId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scanner" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/scanners" : { "get" : { "tags" : [ "scanners" ], "summary" : "Get a list of scanners", "operationId" : "getScannerList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Scanner" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "scanners" ], "summary" : "Get header with count", "operationId" : "getScannerHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/scans/{scanId}/crawled-urls" : { "get" : { "tags" : [ "scans" ], "summary" : "Get the crawled URLs for a scan", "operationId" : "getCrawledUrlsForScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/discovery" : { "get" : { "tags" : [ "scans" ], "summary" : "Get the discovery results for a scan", "operationId" : "getDiscoveryForScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/issues" : { "get" : { "tags" : [ "scans" ], "summary" : "Get the issues for a scan", "operationId" : "getIssuesForScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/log" : { "get" : { "tags" : [ "scans" ], "summary" : "Get the log for a scan", "operationId" : "getLogForScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}" : { "get" : { "tags" : [ "scans" ], "summary" : "Get a scan", "operationId" : "getScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanLog" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans" : { "get" : { "tags" : [ "scans" ], "summary" : "Get a list of scans", "operationId" : "getScanList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScanLog" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "scans" ], "summary" : "Create a scan", "operationId" : "postScan", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanLog" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "scans" ], "summary" : "Get header with count", "operationId" : "getScanHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/metadata" : { "get" : { "tags" : [ "scans" ], "summary" : "Get metadata for a scan", "operationId" : "getScanMetadata", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScanLogMetadata" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/blueprints" : { "post" : { "tags" : [ "scans" ], "summary" : "Request a blueprint", "operationId" : "requestBlueprint", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW|SCANS_VIEW_AND_MANAGE" } } }, "/scans/{scanId}/stop" : { "post" : { "tags" : [ "scans" ], "summary" : "Stop a scan", "operationId" : "stopScan", "parameters" : [ { "name" : "scanId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW_AND_MANAGE" } } }, "/scheduled-reports/{scheduledReportId}" : { "get" : { "tags" : [ "scheduled-reports" ], "summary" : "Get a scheduled report", "operationId" : "getScheduledReport", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScheduledReport" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW|SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scheduled-reports" ], "summary" : "Delete a scheduled report", "operationId" : "deleteScheduledReport", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "scheduled-reports" ], "summary" : "Partially update a scheduled report", "operationId" : "patchScheduledReport", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ScheduledReport" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/scheduled-reports/{scheduledReportId}/schedules/{scheduleId}" : { "put" : { "tags" : [ "scheduled-reports" ], "summary" : "Create a link to a schedule", "operationId" : "putScheduledReportScheduleLink", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scheduled-reports" ], "summary" : "Delete a link to a schedule", "operationId" : "deleteScheduledReportScheduleLink", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/scheduled-reports/{scheduledReportId}/tags/{tagId}" : { "put" : { "tags" : [ "scheduled-reports" ], "summary" : "Create a link to a tag", "operationId" : "putScheduledReportTagLink", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "scheduled-reports" ], "summary" : "Delete a link to a tag", "operationId" : "deleteScheduledReportTagLink", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/scheduled-reports" : { "get" : { "tags" : [ "scheduled-reports" ], "summary" : "Get a list of scheduled reports", "operationId" : "getScheduledReportList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScheduledReport" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW|SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "scheduled-reports" ], "summary" : "Create a scheduled report", "operationId" : "postScheduledReport", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScheduledReport" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "scheduled-reports" ], "summary" : "Get header with count", "operationId" : "getScheduledReportHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW|SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/scheduled-reports/{scheduledReportId}/tags" : { "put" : { "tags" : [ "scheduled-reports" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_10", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/scheduled-reports/{scheduledReportId}/send" : { "post" : { "tags" : [ "scheduled-reports" ], "summary" : "Send report", "operationId" : "sendScheduledReport", "parameters" : [ { "name" : "scheduledReportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULED_REPORTS_VIEW_AND_MANAGE" } } }, "/schedules/{scheduleId}" : { "get" : { "tags" : [ "schedules" ], "summary" : "Get a schedule", "operationId" : "getSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW|SCHEDULES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "schedules" ], "summary" : "Delete a schedule", "operationId" : "deleteSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "schedules" ], "summary" : "Partially update a schedule", "operationId" : "patchSchedule", "parameters" : [ { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Schedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW_AND_MANAGE" } } }, "/schedules" : { "get" : { "tags" : [ "schedules" ], "summary" : "Get a list of schedules", "operationId" : "getScheduleList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Schedule" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW|SCHEDULES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "schedules" ], "summary" : "Create a schedule", "operationId" : "postSchedule", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Schedule" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "schedules" ], "summary" : "Get header with count", "operationId" : "getScheduleHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCHEDULES_VIEW|SCHEDULES_VIEW_AND_MANAGE" } } }, "/scoping" : { "post" : { "tags" : [ "scoping" ], "summary" : "Submit scoping information.", "operationId" : "submitScopingInformation", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScopingInformation" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SCOPING_SUBMIT" } } }, "/sub-users/me/change-password" : { "post" : { "tags" : [ "sub-users" ], "summary" : "Change current sub-users password; if current user isn't a sub-user, redirect to /users/me/change-password", "operationId" : "changePasswordCurrentSubUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangePasswordRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/sub-users/{subUserId}" : { "get" : { "tags" : [ "sub-users" ], "summary" : "Get a sub-user", "operationId" : "getSubUser", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubUser" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "sub-users" ], "summary" : "Delete a sub-user", "operationId" : "deleteSubUser", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "sub-users" ], "summary" : "Partially update a sub-user", "operationId" : "patchSubUser", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/SubUser" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/sub-users/{subUserId}/tags/{tagId}" : { "put" : { "tags" : [ "sub-users" ], "summary" : "Create a link to a tag", "operationId" : "putSubUserTagLink", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "sub-users" ], "summary" : "Delete a link to a tag", "operationId" : "deleteSubUserTagLink", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/sub-users/me" : { "get" : { "tags" : [ "sub-users" ], "summary" : "Get current sub-user; if current user isn't a sub-user, redirect to /users/me", "operationId" : "getCurrentSubUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "sub-users" ], "summary" : "Partially update current sub-user; if current user isn't a sub-user, redirect to /users/me", "operationId" : "patchCurrentSubUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/SubUser" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/sub-users" : { "get" : { "tags" : [ "sub-users" ], "summary" : "Get a list of sub-users", "operationId" : "getSubUserList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubUser" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "sub-users" ], "summary" : "Create a new sub-user", "operationId" : "postSubUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubUser" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "sub-users" ], "summary" : "Get header with count", "operationId" : "getSubUserHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } } }, "/sub-users/{subUserId}/tags" : { "put" : { "tags" : [ "sub-users" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_11", "parameters" : [ { "name" : "subUserId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/subscription-audits/{auditId}" : { "get" : { "tags" : [ "subscription-audits" ], "summary" : "Get a subscription audit", "operationId" : "getSubscriptionAudit", "parameters" : [ { "name" : "auditId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAudit" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscription-audits" : { "get" : { "tags" : [ "subscription-audits" ], "summary" : "Get a list of subscription audits", "operationId" : "getSubscriptionAuditList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionAudit" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "subscription-audits" ], "summary" : "Get header with count", "operationId" : "getSubscriptionAuditHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/{subscriptionUuid}/activate-verification" : { "post" : { "tags" : [ "subscriptions" ], "summary" : "Activate a subscription of type VERIFICATION", "operationId" : "activateVerificationSubscription", "parameters" : [ { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "request-verification", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/subscriptions/{subscriptionUuid}" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get a subscription", "operationId" : "getSubscription", "parameters" : [ { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CachedSubscription" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "subscriptions" ], "summary" : "Delete a subscription", "operationId" : "deleteSubscription", "parameters" : [ { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "subscriptions" ], "summary" : "Partially update a subscription", "operationId" : "patchSubscription", "parameters" : [ { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Subscription" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/templates/{subscriptionTemplateUuid}" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get a subscription template", "operationId" : "getSubscriptionTemplate", "parameters" : [ { "name" : "subscriptionTemplateUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTemplate" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "subscriptions" ], "summary" : "Delete a subscription template", "operationId" : "deleteSubscriptionTemplate", "parameters" : [ { "name" : "subscriptionTemplateUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "subscriptions" ], "summary" : "Partially update a subscription template", "operationId" : "patchSubscriptionTemplate", "parameters" : [ { "name" : "subscriptionTemplateUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/{subscriptionUuid}/asset-groups" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get asset groups associated with the subscription", "operationId" : "getAssociatedAssetGroups", "parameters" : [ { "name" : "subscriptionUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/subscriptions" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get a list of subscriptions", "operationId" : "getSubscriptionList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Subscription" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "subscriptions" ], "summary" : "Create a subscription", "operationId" : "postSubscription", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Subscription" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "subscriptions" ], "summary" : "Get header with count", "operationId" : "getSubscriptionHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "allowedOnHiab" : false, "allowNotEnrolled" : false, "requiredPermissions" : "SUBSCRIPTIONS_VIEW|SUBSCRIPTIONS_VIEW_AND_MANAGE" } } }, "/subscriptions/templates" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get a list of subscription templates", "operationId" : "getSubscriptionTemplateList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionTemplate" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "subscriptions" ], "summary" : "Create a subscription template", "operationId" : "postSubscriptionTemplate", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "subscriptions" ], "summary" : "Get header with count", "operationId" : "getSubscriptionTemplateHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/templates/{subscriptionTemplateUuid}/template-variables" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get variables for subscription templates", "operationId" : "getSubscriptionTemplateVariables", "parameters" : [ { "name" : "subscriptionTemplateUuid", "in" : "path", "required" : true, "schema" : { "pattern" : "[a-fA-F\\d]{8}-[a-fA-F\\d]{4}-4[a-fA-F\\d]{3}-[89aAbB][a-fA-F\\d]{3}-[a-fA-F\\d]{12}", "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionTemplateVariable" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/template-variables" : { "get" : { "tags" : [ "subscriptions" ], "summary" : "Get variables for subscription templates", "operationId" : "getTemplateVariables_1", "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionTemplateVariable" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/templates/preview" : { "post" : { "tags" : [ "subscriptions" ], "summary" : "Preview a subscription template", "operationId" : "previewSubscriptionTemplate", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTemplatePreviewRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "text/plain" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/subscriptions/reports" : { "post" : { "tags" : [ "subscriptions" ], "summary" : "Generate a report", "operationId" : "requestSubscriptionReport", "parameters" : [ { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionReport" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : false, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager|ghostlabs", "allowedOnHiab" : false, "allowNotEnrolled" : false } } }, "/summaries/{summaryId}" : { "get" : { "tags" : [ "summaries" ], "summary" : "Get a summary", "operationId" : "getSummary", "parameters" : [ { "name" : "summaryId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Summary" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "summaries" ], "summary" : "Delete a summary", "operationId" : "deleteSummary", "parameters" : [ { "name" : "summaryId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "summaries" ], "summary" : "Partially update a summary", "operationId" : "patchSummary", "parameters" : [ { "name" : "summaryId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Summary" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/summaries" : { "get" : { "tags" : [ "summaries" ], "summary" : "Get a list of summaries", "operationId" : "getSummaryList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Summary" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "summaries" ], "summary" : "Create a summary", "operationId" : "postSummary", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Summary" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "summaries" ], "summary" : "Get header with count", "operationId" : "getSummaryHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/summaries/{summaryId}/transition" : { "post" : { "tags" : [ "summaries" ], "summary" : "Transition a summary status", "operationId" : "transitionSummary", "parameters" : [ { "name" : "summaryId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SummaryTransitionRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|swatservice|superswatservice|ghostlabs", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/tags/{tagId}" : { "get" : { "tags" : [ "tags" ], "summary" : "Get a tag by ID", "operationId" : "getTag", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "tags" ], "summary" : "Delete a tag", "operationId" : "deleteTag", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "TAGS_MANAGE" } }, "patch" : { "tags" : [ "tags" ], "summary" : "Partially update a tag", "operationId" : "patchTag", "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "TAGS_MANAGE" } } }, "/tags" : { "get" : { "tags" : [ "tags" ], "summary" : "Get a list of tags", "operationId" : "getTagList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "tags" ], "summary" : "Create a tag", "operationId" : "postTag", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "TAGS_MANAGE" } }, "head" : { "tags" : [ "tags" ], "summary" : "Get header with count", "operationId" : "getTagHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/tags/statistics/{statisticId}" : { "get" : { "tags" : [ "tags" ], "summary" : "Get tag statistics by ID", "operationId" : "getTagStatistic", "parameters" : [ { "name" : "statisticId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagStatistic" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/tags/statistics" : { "get" : { "tags" : [ "tags" ], "summary" : "Get a list of tag statistics", "operationId" : "getTagStatisticList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagStatistic" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "tags" ], "summary" : "Get header with count", "operationId" : "getTagStatisticHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/tags/transform" : { "post" : { "tags" : [ "tags" ], "summary" : "Transform tags", "operationId" : "transformTag", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagsTransformation" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "TAGS_MANAGE" } } }, "/templates/render" : { "post" : { "tags" : [ "templates" ], "summary" : "Generates sample values that is then used to render a provided Jinja template", "operationId" : "postRender", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TemplateRenderRequest" } } } }, "responses" : { "default" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RenderedOutput" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms/{termsId}/accept" : { "post" : { "tags" : [ "terms" ], "summary" : "Accept terms", "operationId" : "acceptTerms", "parameters" : [ { "name" : "termsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms/{termsId}" : { "get" : { "tags" : [ "terms" ], "summary" : "Get terms", "operationId" : "getTerms", "parameters" : [ { "name" : "termsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Terms" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "terms" ], "summary" : "Delete terms", "operationId" : "deleteTerms", "parameters" : [ { "name" : "termsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "terms" ], "summary" : "Update accept if all or main user must accept terms.", "operationId" : "updateAcceptRule", "parameters" : [ { "name" : "termsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/UserRole" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms/acceptances" : { "get" : { "tags" : [ "terms" ], "summary" : "Get a list of terms acceptances", "operationId" : "getTermsAcceptances", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TermsAcceptance" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms" : { "get" : { "tags" : [ "terms" ], "summary" : "Get a list of terms", "operationId" : "getTermsList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Terms" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "terms" ], "summary" : "Create terms", "operationId" : "postTerms", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Terms" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "terms" ], "summary" : "Get header with count", "operationId" : "getTermsHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms-templates/{termsTemplateId}" : { "get" : { "tags" : [ "terms-templates" ], "summary" : "Get a terms template", "operationId" : "getTermsTemplate", "parameters" : [ { "name" : "termsTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TermsTemplate" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager|legal", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "terms-templates" ], "summary" : "Delete a terms template", "operationId" : "deleteTermsTemplate", "parameters" : [ { "name" : "termsTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/terms-templates" : { "get" : { "tags" : [ "terms-templates" ], "summary" : "Get a list of terms templates", "operationId" : "getTermsTemplateList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TermsTemplate" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager|legal", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "terms-templates" ], "summary" : "Create a terms template", "operationId" : "postTermsTemplate", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TermsTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "terms-templates" ], "summary" : "Get header with count", "operationId" : "getTermsTemplateHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|licensemanager|legal", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/usage-stats/cyr3con" : { "get" : { "tags" : [ "usage-stats" ], "summary" : "Get cyr3con stats", "operationId" : "getCyr3conStats", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/usage-stats/{usageStatsId}" : { "get" : { "tags" : [ "usage-stats" ], "summary" : "Get usage stats by ID", "operationId" : "getUsageStats", "parameters" : [ { "name" : "usageStatsId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsageStats" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/usage-stats" : { "get" : { "tags" : [ "usage-stats" ], "summary" : "Get a list of usage stats", "operationId" : "getUsageStatsList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UsageStats" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "usage-stats" ], "summary" : "Get header with count", "operationId" : "getUsageStatsHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "admin|support|licensemanager|customersuccess|msspmanager", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/user-role-permissions/{userRolePermissionId}" : { "get" : { "tags" : [ "user-role-permissions" ], "summary" : "Get a user role permission", "operationId" : "getUserRolePermission", "parameters" : [ { "name" : "userRolePermissionId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRolePermission" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/user-role-permissions" : { "get" : { "tags" : [ "user-role-permissions" ], "summary" : "Get a list of user role permissions", "operationId" : "getUserRolePermissionList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserRolePermission" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "head" : { "tags" : [ "user-role-permissions" ], "summary" : "Get header with count", "operationId" : "getUserRolePermissionHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/user-roles/{userRoleId}" : { "get" : { "tags" : [ "user-roles" ], "summary" : "Get a user role", "operationId" : "getUserRole", "parameters" : [ { "name" : "userRoleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRole" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "delete" : { "tags" : [ "user-roles" ], "summary" : "Delete a user role", "operationId" : "deleteUserRole", "parameters" : [ { "name" : "userRoleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "user-roles" ], "summary" : "Partially update a user role", "operationId" : "patchUserRole", "parameters" : [ { "name" : "userRoleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/UserRole" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/user-roles" : { "get" : { "tags" : [ "user-roles" ], "summary" : "Get a list of user roles", "operationId" : "getUserRoleList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserRole" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "post" : { "tags" : [ "user-roles" ], "summary" : "Create a user role", "operationId" : "postUserRole", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRole" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "user-roles" ], "summary" : "Get header with count", "operationId" : "getUserRoleHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/users/me/change-password" : { "post" : { "tags" : [ "users" ], "summary" : "Change current users password; if current user is a sub-user, redirect to /sub-users/me/change-password", "operationId" : "changePasswordCurrentUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangePasswordRequest" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/users/{userId}/tags/{tagId}" : { "put" : { "tags" : [ "users" ], "summary" : "Create a link to a tag", "operationId" : "putUserTagLink", "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "users" ], "summary" : "Delete a link to a tag", "operationId" : "deleteUserTagLink", "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/users/me" : { "get" : { "tags" : [ "users" ], "summary" : "Get current user; if current user is a sub-user, redirect to /sub-users/me", "operationId" : "getCurrentUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } }, "patch" : { "tags" : [ "users" ], "summary" : "Partially update current user; if current user is a sub-user, redirect to /sub-users/me", "operationId" : "patchCurrentUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false } } }, "/users/{userId}" : { "get" : { "tags" : [ "users" ], "summary" : "Get a user", "operationId" : "getUser", "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "users" ], "summary" : "Partially update a user", "operationId" : "patchUser", "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/users" : { "get" : { "tags" : [ "users" ], "summary" : "Get a list of users", "operationId" : "getUserList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "users" ], "summary" : "Get header with count", "operationId" : "getUserHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW|USERS_VIEW_AND_MANAGE" } } }, "/users/{userId}/tags" : { "put" : { "tags" : [ "users" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_12", "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "requiredRoles" : "mainuser", "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "USERS_VIEW_AND_MANAGE" } } }, "/view-template-groups/{viewTemplateGroupId}" : { "get" : { "tags" : [ "view-template-groups" ], "summary" : "Get view template group", "operationId" : "getViewTemplateGroup", "parameters" : [ { "name" : "viewTemplateGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplateGroup" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "view-template-groups" ], "summary" : "Delete view template group", "operationId" : "deleteViewTemplateGroup", "parameters" : [ { "name" : "viewTemplateGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "view-template-groups" ], "summary" : "Partially update a view template group", "operationId" : "patchViewTemplateGroup", "parameters" : [ { "name" : "viewTemplateGroupId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplateGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/view-template-groups" : { "get" : { "tags" : [ "view-template-groups" ], "summary" : "Get a list of view template groups", "operationId" : "getViewTemplateGroupList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ViewTemplateGroup" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "view-template-groups" ], "summary" : "Create a view template group", "operationId" : "postViewTemplateGroup", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplateGroup" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "view-template-groups" ], "summary" : "Get header with count", "operationId" : "getViewTemplateGroupHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/view-templates" : { "get" : { "tags" : [ "view-templates" ], "summary" : "Get a list of view templates", "operationId" : "getViewTemplateList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ViewTemplate" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "view-templates" ], "summary" : "Create a view template", "operationId" : "createViewTemplate", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "view-templates" ], "summary" : "Get header with count", "operationId" : "getViewTemplatesHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/view-templates/{viewTemplateId}" : { "get" : { "tags" : [ "view-templates" ], "summary" : "Get view template by ID", "operationId" : "getViewTemplate", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplate" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW|VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "view-templates" ], "summary" : "Delete a view template", "operationId" : "deleteViewTemplate", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "view-templates" ], "summary" : "Partially update a view template", "operationId" : "patchViewTemplate", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/ViewTemplate" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/view-templates/{viewTemplateId}/tags/{tagId}" : { "put" : { "tags" : [ "view-templates" ], "summary" : "Create a link to a tag", "operationId" : "putViewTemplateTagLink", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "view-templates" ], "summary" : "Delete a link to a tag", "operationId" : "deleteViewTemplateTagLink", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/view-templates/{viewTemplateId}/tags" : { "put" : { "tags" : [ "view-templates" ], "summary" : "Modify linked set of tags", "operationId" : "modifyTagLinks_13", "parameters" : [ { "name" : "viewTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "VIEW_TEMPLATES_VIEW_AND_MANAGE" } } }, "/workflows/{workflowId}" : { "get" : { "tags" : [ "workflows" ], "summary" : "Get a workflow", "operationId" : "getWorkflow", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Workflow" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "workflows" ], "summary" : "Delete a workflow", "operationId" : "deleteWorkflow", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "patch" : { "tags" : [ "workflows" ], "summary" : "Partially update a workflow", "operationId" : "patchWorkflow", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "schema" : { "$ref" : "#/components/schemas/Workflow" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/workflows/{workflowId}/schedules/{scheduleId}" : { "put" : { "tags" : [ "workflows" ], "summary" : "Create a link to a schedule", "operationId" : "putWorkflowScheduleLink", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "workflows" ], "summary" : "Delete a link to a schedule", "operationId" : "deleteWorkflowScheduleLink", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "scheduleId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/workflows/{workflowId}/tags/{tagId}" : { "put" : { "tags" : [ "workflows" ], "summary" : "Create a link to a tag", "operationId" : "putWorkflowTagLink", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "delete" : { "tags" : [ "workflows" ], "summary" : "Delete a link to a tag", "operationId" : "deleteWorkflowTagLink", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/workflows" : { "get" : { "tags" : [ "workflows" ], "summary" : "Get a list of workflows", "operationId" : "getWorkflowList", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of entries to return", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "offset", "in" : "query", "description" : "Zero-based offset from first entry in list", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "sort", "in" : "query", "description" : "Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order", "schema" : { "type" : "string", "default" : "" } }, { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } }, "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Workflow" } } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "post" : { "tags" : [ "workflows" ], "summary" : "Create a workflow", "operationId" : "postWorkflow", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "A comma-separated string of fields to request", "schema" : { "type" : "string" } }, { "name" : "return-result", "in" : "query", "description" : "\"true\" to return the object(s) created/modified in e.g. a POST or PATCH", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Workflow" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } }, "head" : { "tags" : [ "workflows" ], "summary" : "Get header with count", "operationId" : "getWorkflowHeader", "parameters" : [ { "name" : "filter", "in" : "query", "description" : "JSON array with filters; [{\"field\":\"<name>\",\"value\":\"<string|number|boolean>\",\"comparison\":\"<eq|ne|gt|lt|any|all|none|today|null>\"}]", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "headers" : { "Count" : { "description" : "The number of total entries, without limit and offset", "style" : "simple", "schema" : { "type" : "integer" } } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW|SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/workflows/{workflowId}/tags" : { "put" : { "tags" : [ "workflows" ], "summary" : "Modify linked set of tags", "operationId" : "modifyWorkflowTagLinks", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array" } } }, "required" : true }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE" } } }, "/workflows/{workflowId}/scan" : { "post" : { "tags" : [ "workflows" ], "summary" : "Start scans based on this workflow", "operationId" : "scanWorkflow", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } }, "security" : [ { "bearerAuth" : [ ] } ], "x-o24" : { "allowedOnScanner" : true, "allowedOnOutscan" : true, "allowedOnHiab" : true, "allowNotEnrolled" : false, "requiredPermissions" : "SCANS_VIEW_AND_MANAGE" } } } }, "components" : { "schemas" : { "VersionInfo" : { "type" : "object", "properties" : { "software" : { "type" : "string", "enum" : [ "AGENT", "RULES" ] }, "version" : { "type" : "string" } } }, "Account" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "type" : { "type" : "string", "enum" : [ "SMB", "SSH", "BASIC", "WEB", "AWS", "AZURE", "VSPHERE", "GCP", "DOCKER", "WINRM" ] }, "name" : { "minLength" : 1, "type" : "string" }, "url" : { "pattern" : "^https?://.*", "type" : "string" }, "role" : { "type" : "string" }, "integrationId" : { "type" : "integer", "format" : "int32" }, "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Credential" } }, "assetIdentifierIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "scanConfigurationIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "scanPolicyIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "status" : { "type" : "string", "enum" : [ "VALID", "INVALID", "UNUSED" ] }, "statusComment" : { "type" : "string" }, "customerName" : { "type" : "string" }, "managed" : { "type" : "boolean" }, "createdByGhostLabs" : { "type" : "boolean" }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "assetGroups" : { "type" : "array", "description" : "Information of all asset groups the customer is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Account.AssetGroup" } } } }, "Account.AssetGroup" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" } }, "description" : "Information of all asset groups the customer is linked to", "readOnly" : true }, "Credential" : { "required" : [ "accountId", "classId", "value" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "accountId" : { "type" : "integer", "format" : "int32" }, "classId" : { "type" : "integer", "format" : "int32" }, "className" : { "type" : "string" }, "value" : { "type" : "string" }, "managed" : { "type" : "boolean" }, "createdByGhostLabs" : { "type" : "boolean" }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Tag" : { "required" : [ "key" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "key" : { "minLength" : 1, "type" : "string" }, "value" : { "type" : "string" }, "inherited" : { "type" : "boolean", "readOnly" : true }, "count" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "description" : "The tags", "readOnly" : true }, "AgentInstallerCreationRequest" : { "required" : [ "arch", "pkg", "platform" ], "type" : "object", "properties" : { "platform" : { "minLength" : 1, "type" : "string" }, "arch" : { "minLength" : 1, "type" : "string" }, "pkg" : { "minLength" : 1, "type" : "string" }, "customAttributes" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValueTag" } }, "expires" : { "type" : "string" }, "allowedUses" : { "type" : "integer", "format" : "int64" } }, "description" : "Agent installer creation request" }, "KeyValueTag" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "value" : { "type" : "string" } }, "description" : "Tag with key and value only" }, "Announcement" : { "required" : [ "announcementType", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "description" : "The name of the announcement" }, "announcementType" : { "type" : "string", "description" : "The type of this announcement", "enum" : [ "NEWSLETTER", "COMMERCIAL", "CUSTOMER_COMMUNICATION", "RELEASE_NOTE" ] }, "url" : { "type" : "string", "description" : "An optional url" }, "subject" : { "type" : "string", "description" : "The subject of the announcement" }, "content" : { "type" : "string", "description" : "The content of the announcement" } } }, "Appliance" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "readOnly" : true }, "primary" : { "type" : "boolean", "readOnly" : true }, "virtual" : { "type" : "boolean", "readOnly" : true }, "revoked" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "mac" : { "type" : "string", "readOnly" : true }, "updatedOnline" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "updatedOffline" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "versions" : { "$ref" : "#/components/schemas/Appliance.ApplianceVersion" } } }, "Appliance.ApplianceVersion" : { "type" : "object", "properties" : { "xmlapi" : { "type" : "string" }, "ui" : { "type" : "string" }, "scanner" : { "type" : "string" }, "rules" : { "type" : "string" } }, "readOnly" : true }, "Activity" : { "required" : [ "activityType" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "assetGroupId" : { "type" : "integer", "description" : "The id of the AssetGroup this activity is related to", "format" : "int32", "readOnly" : true }, "activityType" : { "type" : "string", "description" : "The type of this activity", "enum" : [ "PENTEST_COMPLETED", "ONBOARDING_COMPLETED", "FALSE_POSITIVE_DISCARDED", "NEW_VULNERABILITY_CHECK", "EXECUTIVE_SUMMARY_UPDATED", "VERIFICATION_REQUEST_COMPLETED" ] }, "description" : { "type" : "string", "description" : "An optional description of the activity" } } }, "AssetGroup" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The name of the asset group" }, "type" : { "type" : "string", "description" : "The assetgroup's type", "enum" : [ "WEB_APP", "INSTANCE", "API", "INTERNAL", "EXTERNAL", "MOBILE", "PHYSICAL", "WIRELESS", "PHISHING", "RED", "ASSUMED", "DIGITAL", "HARDWARE", "PROJECT" ] }, "parentId" : { "type" : "integer", "description" : "The parent asset group", "format" : "int32" }, "assetIds" : { "type" : "array", "description" : "The component assets", "readOnly" : true, "items" : { "type" : "integer", "description" : "The component assets", "format" : "int32", "readOnly" : true } }, "assetGroupIds" : { "type" : "array", "description" : "The children asset groups", "readOnly" : true, "items" : { "type" : "integer", "description" : "The children asset groups", "format" : "int32", "readOnly" : true } }, "summaryId" : { "type" : "integer", "description" : "The ID of the executive summary", "format" : "int32", "readOnly" : true }, "summary" : { "type" : "string", "description" : "The content of the executive summary", "readOnly" : true }, "summaryPublishedAt" : { "type" : "string", "description" : "When the executive summary was published", "format" : "date-time", "readOnly" : true }, "path" : { "type" : "array", "description" : "The path of the asset group tree", "readOnly" : true, "items" : { "type" : "integer", "description" : "The path of the asset group tree", "format" : "int32", "readOnly" : true } }, "activeSubscriptionTypes" : { "type" : "array", "description" : "The assetgroup's active subscription types", "readOnly" : true, "items" : { "type" : "string", "description" : "The assetgroup's active subscription types", "readOnly" : true, "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] } }, "managed" : { "type" : "boolean", "description" : "Managed internally by (e.g SWAT API or GhostLab)", "readOnly" : true }, "dynamic" : { "type" : "boolean", "description" : "Indicates whether the asset group is automatically populated with assets based on the assigned tags" }, "labels" : { "type" : "string", "description" : "The labels of the asset group" }, "contactName" : { "type" : "string", "description" : "The customer's contact name with regards to this asset group" }, "contactDetails" : { "type" : "string", "description" : "The customer's contact details" }, "additionalDetails" : { "type" : "string", "description" : "Additional information about the asset group that may require attention" }, "commentPendingSince" : { "type" : "string", "description" : "The date since comment is pending", "format" : "date-time", "readOnly" : true }, "commentsCount" : { "type" : "integer", "description" : "The number of comments", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "description" : "The customer name" }, "engagementRequestStatus" : { "type" : "string", "description" : "The status of the most recent engagement request associated to this asset group", "enum" : [ "NEW", "IN_REVIEW", "MISSING_INFORMATION", "SCHEDULED", "DONE", "CANCELLED" ] }, "accountIds" : { "type" : "array", "description" : "The IDs of the accounts linked to this asset group", "readOnly" : true, "items" : { "type" : "integer", "description" : "The IDs of the accounts linked to this asset group", "format" : "int32", "readOnly" : true } }, "source" : { "type" : "array", "description" : "The asset group sources", "items" : { "type" : "string", "description" : "The asset group sources", "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "includedDynamicTags" : { "type" : "array", "description" : "The included dynamic asset tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "excludedDynamicTags" : { "type" : "array", "description" : "The excluded dynamic asset tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Comment" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "parentId" : { "type" : "integer", "description" : "ID of the parent comment if this comment is a reply", "format" : "int32" }, "comment" : { "type" : "string", "description" : "The content of the comment" }, "entityType" : { "type" : "string", "description" : "The type of object this comment is made for", "enum" : [ "FINDING", "ASSET_GROUP", "ASSET", "SCAN_CONFIGURATION", "SCHEDULE", "SCAN", "USER", "USER_ACCOUNT", "ROLE", "RESOURCE_GROUP", "COMPLIANCE", "WORKFLOW", "CHECK", "PRODUCT_INFORMATION", "INFORMATION", "ENGAGEMENT_REQUEST", "MANAGED_REPORT", "SCHEDULED_REPORT", "AUTOMATION_RULE", "CVE", "AGENT" ] }, "entityId" : { "type" : "integer", "description" : "The ID of the object this comment is made for", "format" : "int32" }, "supportStatus" : { "type" : "string", "description" : "Current support status of the comment", "enum" : [ "NOT_APPLICABLE", "WAITING", "DONE", "INTERNAL" ] }, "authorIsStaff" : { "type" : "boolean", "description" : "Whether the comment is from Outpost24 or the customer", "readOnly" : true }, "deleted" : { "type" : "string", "description" : "When the comment was deleted", "format" : "date-time" } } }, "Subscription" : { "type" : "object", "properties" : { "uuid" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] }, "associations" : { "$ref" : "#/components/schemas/Subscription.Associations" }, "durationInDays" : { "type" : "integer", "format" : "int32" }, "activeUntil" : { "type" : "string", "format" : "date-time" }, "activatedAt" : { "type" : "string", "format" : "date-time" }, "redeemableUntil" : { "type" : "string", "format" : "date-time" }, "created" : { "type" : "string", "format" : "date-time" }, "createdBy" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" }, "template" : { "$ref" : "#/components/schemas/Subscription.Template" }, "customer" : { "$ref" : "#/components/schemas/Subscription.Customer" }, "limits" : { "$ref" : "#/components/schemas/Subscription.Limits" }, "isActive" : { "type" : "boolean" }, "deletedAt" : { "type" : "string", "format" : "date-time" } } }, "Subscription.Associations" : { "type" : "object", "properties" : { "assetGroups" : { "type" : "array", "items" : { "type" : "string" } } } }, "Subscription.Customer" : { "required" : [ "uuid" ], "type" : "object", "properties" : { "uuid" : { "minLength" : 1, "type" : "string" } } }, "Subscription.Limits" : { "type" : "object", "properties" : { "netsecAssets" : { "type" : "integer", "description" : "The netsec assets", "format" : "int32" }, "netsecScans" : { "type" : "integer", "description" : "The netsec scans", "format" : "int32" }, "netsecInternalAssets" : { "type" : "integer", "description" : "The netsec internal assets", "format" : "int32" }, "netsecInternalScans" : { "type" : "integer", "description" : "The netsec internal scans", "format" : "int32" }, "netsecApplianceAssets" : { "type" : "integer", "description" : "The netsec appliance assets", "format" : "int32" }, "netsecApplianceScans" : { "type" : "integer", "description" : "The netsec appliance scans", "format" : "int32" }, "netsecApplianceExternalAssets" : { "type" : "integer", "description" : "The netsec appliance external assets", "format" : "int32" }, "netsecApplianceExternalScans" : { "type" : "integer", "description" : "The netsec appliance external scans", "format" : "int32" }, "complianceAssets" : { "type" : "integer", "description" : "The compliance assets", "format" : "int32" }, "complianceScans" : { "type" : "integer", "description" : "The compliance scans", "format" : "int32" }, "complianceInternalAssets" : { "type" : "integer", "description" : "The compliance internal assets", "format" : "int32" }, "complianceInternalScans" : { "type" : "integer", "description" : "The compliance internal scans", "format" : "int32" }, "complianceApplianceAssets" : { "type" : "integer", "description" : "The compliance appliance assets", "format" : "int32" }, "complianceApplianceScans" : { "type" : "integer", "description" : "The compliance appliance scans", "format" : "int32" }, "complianceApplianceExternalAssets" : { "type" : "integer", "description" : "The compliance appliance external assets", "format" : "int32" }, "complianceApplianceExternalScans" : { "type" : "integer", "description" : "The compliance appliance external scans", "format" : "int32" }, "pciAssets" : { "type" : "integer", "description" : "The pci assets", "format" : "int32" }, "pciScans" : { "type" : "integer", "description" : "The pci scans", "format" : "int32" }, "scaleAssets" : { "type" : "integer", "description" : "The scale assets", "format" : "int32" }, "scaleScans" : { "type" : "integer", "description" : "The scale scans", "format" : "int32" }, "scaleInternalAssets" : { "type" : "integer", "description" : "The scale internal assets", "format" : "int32" }, "scaleApplianceAssets" : { "type" : "integer", "description" : "The scale appliance assets", "format" : "int32" }, "scaleApplianceScans" : { "type" : "integer", "description" : "The scale appliance scans", "format" : "int32" }, "scaleApplianceExternalScans" : { "type" : "integer", "description" : "The scale appliance external scans", "format" : "int32" }, "scaleApplianceExternalAssets" : { "type" : "integer", "description" : "The scale appliance external assets", "format" : "int32" }, "cloudsecAssets" : { "type" : "integer", "description" : "The cloudsec assets", "format" : "int32" }, "cloudsecScans" : { "type" : "integer", "description" : "The cloudsec scans", "format" : "int32" }, "networkDiscoveryScans" : { "type" : "integer", "description" : "The network discovery scans", "format" : "int32" }, "networkDiscoveryApplianceScans" : { "type" : "integer", "description" : "The network discovery appliance scans", "format" : "int32" }, "networkLookups" : { "type" : "integer", "description" : "The network lookups", "format" : "int32" }, "networkApplianceLookups" : { "type" : "integer", "description" : "The network appliance lookups", "format" : "int32" }, "cloudDiscoveryScans" : { "type" : "integer", "description" : "The cloud discovery scans", "format" : "int32" }, "cloudDiscoveryApplianceScans" : { "type" : "integer", "description" : "The cloud discovery appliance scans", "format" : "int32" }, "networkAssets" : { "type" : "integer", "description" : "The network assets", "format" : "int32" }, "networkScans" : { "type" : "integer", "description" : "The network scans", "format" : "int32" }, "networkApplianceAssets" : { "type" : "integer", "description" : "The network appliance assets", "format" : "int32" }, "networkApplianceScans" : { "type" : "integer", "description" : "The network appliance scans", "format" : "int32" }, "dockerImageDiscoveryScans" : { "type" : "integer", "description" : "The docker image discovery scans", "format" : "int32" }, "dockerImageAssets" : { "type" : "integer", "description" : "The docker image assets", "format" : "int32" }, "dockerImageScans" : { "type" : "integer", "description" : "The docker image scans", "format" : "int32" }, "dockerImageDiscoveryApplianceScans" : { "type" : "integer", "description" : "The docker image discovery appliance scans", "format" : "int32" }, "dockerImageApplianceAssets" : { "type" : "integer", "description" : "The docker image appliance assets", "format" : "int32" }, "dockerImageApplianceScans" : { "type" : "integer", "description" : "The docker image appliance scans", "format" : "int32" }, "outscanNXAssets" : { "type" : "integer", "description" : "The outscan NX assets", "format" : "int32" }, "outscanNXApplianceAssets" : { "type" : "integer", "description" : "The outscan NX appliance assets", "format" : "int32" } } }, "Subscription.Template" : { "required" : [ "uuid" ], "type" : "object", "properties" : { "uuid" : { "minLength" : 1, "type" : "string" }, "variables" : { "type" : "string" }, "template" : { "type" : "string" }, "name" : { "type" : "string" } } }, "AgentMatch" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/IdentifierData" }, "type" : { "type" : "string" } } }, "AssetIdentifier" : { "required" : [ "name", "source", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The asset identifier id", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The asset identifier value (for example an IP address, hostname, or agent identifier)" }, "presentableName" : { "type" : "string", "description" : "The presentable name of the asset identifier" }, "type" : { "type" : "string", "description" : "The asset identifier type", "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] }, "firstSeen" : { "type" : "string", "description" : "The first time this identifier was seen", "format" : "date-time" }, "lastSeen" : { "type" : "string", "description" : "The last time this identifier was seen", "format" : "date-time" }, "scannerId" : { "type" : "integer", "description" : "The scanner id associated with this identifier", "format" : "int32" }, "scannerName" : { "type" : "string", "description" : "The scanner name associated with this identifier", "readOnly" : true }, "ownership" : { "type" : "integer", "description" : "The computed ownership value", "format" : "int32", "readOnly" : true }, "customOwnership" : { "maximum" : 100, "minimum" : 0, "type" : "integer", "description" : "The custom ownership value", "format" : "int32" }, "firstScanId" : { "type" : "integer", "description" : "The first scan id associated with this identifier", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "description" : "The last scan id associated with this identifier", "format" : "int32", "readOnly" : true }, "source" : { "type" : "array", "description" : "The sources of the asset identifier", "items" : { "type" : "string", "description" : "The sources of the asset identifier", "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "links" : { "type" : "array", "description" : "The linked asset identifier ids", "readOnly" : true, "items" : { "type" : "integer", "description" : "The linked asset identifier ids", "format" : "int32", "readOnly" : true } }, "assetIds" : { "type" : "array", "description" : "The asset ids associated with this identifier", "items" : { "type" : "integer", "description" : "The asset ids associated with this identifier", "format" : "int32" } }, "assetNames" : { "type" : "array", "description" : "The asset names associated with this identifier", "readOnly" : true, "items" : { "type" : "string", "description" : "The asset names associated with this identifier", "readOnly" : true } }, "accountIds" : { "type" : "array", "description" : "The account ids associated with this identifier", "items" : { "type" : "integer", "description" : "The account ids associated with this identifier", "format" : "int32" } }, "platform" : { "type" : "string", "description" : "The platform for this asset identifier" }, "scanSelectionType" : { "type" : "string", "description" : "The scan selection type", "readOnly" : true, "enum" : [ "INCLUDED", "VHOST_ONLY", "EXCLUDED" ] }, "linkId" : { "type" : "integer", "description" : "The link id", "format" : "int32", "readOnly" : true }, "issues" : { "type" : "string", "description" : "The agent issues payload" }, "tags" : { "type" : "array", "description" : "The tags linked to this asset identifier", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "properties" : { "$ref" : "#/components/schemas/BaseProperties" } }, "description" : "The asset links" }, "AssetIdentifier.AgentProperties" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseProperties" }, { "type" : "object", "properties" : { "uuid" : { "type" : "string" }, "version" : { "type" : "string" }, "lastSynchronized" : { "type" : "string", "format" : "date-time" }, "customAttributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValueTag" } }, "retired" : { "type" : "string", "format" : "date-time" }, "matches" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AgentMatch" } } } } ] }, "AssetIdentifier.DockerImageProperties" : { "required" : [ "type" ], "type" : "object", "description" : "The docker image properties", "allOf" : [ { "$ref" : "#/components/schemas/BaseProperties" }, { "type" : "object", "properties" : { "os" : { "type" : "string" }, "tag" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int64" }, "architecture" : { "type" : "string" } } } ] }, "BaseProperties" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] } }, "description" : "The asset base properties" }, "From" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] }, "identifier" : { "type" : "string" }, "relation" : { "type" : "string" } } }, "IdentifierData" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] }, "identifier" : { "type" : "string" }, "from" : { "$ref" : "#/components/schemas/From" } } }, "AssetIdentifierLink" : { "required" : [ "assetIdentifierId", "firstSeen", "lastSeen", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "assetIdentifierId" : { "type" : "integer", "format" : "int32" }, "firstSeen" : { "type" : "string", "format" : "date-time" }, "lastSeen" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string", "enum" : [ "RESOLVES_TO", "LOADS_SCRIPTS_FROM", "REFERS_IN_TLS_TO", "DNS_CNAME", "DNS_DNAME", "DNS_MX", "DNS_NS", "DNS_PTR", "DNS_SRV", "DNS_A", "DNS_AAAA", "DNS_URI", "CONTAINS", "HTML_LINKS_TO", "ARP" ] } } }, "Asset" : { "required" : [ "name", "source" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The asset id", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The asset name" }, "source" : { "type" : "array", "description" : "The asset sources", "items" : { "type" : "string", "description" : "The asset sources", "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "platform" : { "type" : "string", "description" : "The asset platform", "readOnly" : true }, "assetIdentifierIds" : { "type" : "array", "description" : "The asset identifiers (deprecated)", "items" : { "type" : "integer", "description" : "The asset identifiers (deprecated)", "format" : "int32" } }, "assetIdentifierTypes" : { "type" : "array", "description" : "The asset identifier types (deprecated)", "readOnly" : true, "items" : { "type" : "string", "description" : "The asset identifier types (deprecated)", "readOnly" : true, "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] } }, "activeSubscriptionTypes" : { "type" : "array", "description" : "The asset's active subscription types", "readOnly" : true, "items" : { "type" : "string", "description" : "The asset's active subscription types", "readOnly" : true, "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] } }, "uuid" : { "type" : "string", "description" : "The asset uuid", "readOnly" : true }, "firstScanId" : { "type" : "integer", "description" : "The id of the first scan performed on the asset", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "description" : "The id of last scan performed on the asset", "format" : "int32", "readOnly" : true }, "compliant" : { "type" : "string", "description" : "The asset compliance status", "readOnly" : true, "enum" : [ "COMPLIANT", "NOT_COMPLIANT", "COMPLIANT_WITH_EXCEPTIONS" ] }, "cvssV2EnvironmentalVector" : { "pattern" : "^(CDP:(ND|N|L|LM|MH|H))?(/?TD:(ND|N|L|M|H))?(/?CR:(ND|L|M|H))?(/?IR:(ND|L|M|H))?(/?AR:(ND|L|M|H))?$", "type" : "string", "description" : "The CVSS V2 environmental vector" }, "cvssV3EnvironmentalVector" : { "pattern" : "^(CR:[XLMH])?(/?IR:[XLMH])?(/?AR:[XLMH])?(/?MAV:[XNALP])?(/?MAC:[XLH])?(/?MPR:[XNLH])?(/?MUI:[XNR])?(/?MS:[XUC])?(/?MC:[XNLH])?(/?MI:[XNLH])?(/?MA:[XNLH])?$", "type" : "string", "description" : "The CVSS V3 environmental vector" }, "customerName" : { "type" : "string", "description" : "The customer name" }, "enabled" : { "type" : "boolean", "description" : "Set to true if the asset is enabled" }, "active" : { "type" : "boolean", "description" : "Set to true if the asset is enabled and has active subscriptions", "readOnly" : true }, "openPorts" : { "type" : "integer", "description" : "The number of open ports in last network scan", "format" : "int32", "readOnly" : true }, "dockerImageProperties" : { "$ref" : "#/components/schemas/BaseProperties" }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "assetIdentifiers" : { "type" : "array", "description" : "The asset links", "items" : { "$ref" : "#/components/schemas/AssetIdentifier" } }, "assetGroups" : { "type" : "array", "description" : "Information of all asset groups the asset is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AssetGroupInformation" } }, "authenticationLatestScan" : { "type" : "array", "description" : "The authentication used in the last scan", "items" : { "$ref" : "#/components/schemas/ScanLog.Authentication" } } }, "readOnly" : true }, "AssetGroupInformation" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int32" }, "dynamic" : { "type" : "boolean" } }, "description" : "Information of all asset groups the finding is linked to", "readOnly" : true }, "ScanLog.Authentication" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "SMB", "SSH", "VSPHERE", "BASIC", "LUA", "SELENIUM", "AWS", "AZURE", "GCP", "DOCKER", "PLAYWRIGHT", "WINRM" ] }, "status" : { "type" : "string", "enum" : [ "SUCCESS", "FAILED", "SKIPPED" ] } }, "description" : "The authentication used in the scan" }, "AssetLink" : { "required" : [ "assetIdentifierId", "firstSeen", "lastSeen", "scanSelectionType" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "assetId" : { "type" : "integer", "format" : "int32" }, "assetIdentifierId" : { "type" : "integer", "format" : "int32" }, "firstSeen" : { "type" : "string", "format" : "date-time" }, "lastSeen" : { "type" : "string", "format" : "date-time" }, "scanSelectionType" : { "type" : "string", "enum" : [ "INCLUDED", "VHOST_ONLY", "EXCLUDED" ] } } }, "Audit" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "objectName" : { "type" : "string", "readOnly" : true }, "objectId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "action" : { "type" : "string", "readOnly" : true }, "updatedFields" : { "type" : "object", "additionalProperties" : { "type" : "string", "readOnly" : true }, "readOnly" : true } } }, "SendSmsRequest" : { "required" : [ "phoneNumber" ], "type" : "object", "properties" : { "phoneNumber" : { "minLength" : 1, "type" : "string" } } }, "AutomationRule" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "enabled" : { "type" : "boolean", "description" : "The rule status. Set to true when enabled" }, "name" : { "minLength" : 1, "type" : "string", "description" : "The rule name" }, "order" : { "minimum" : 1, "type" : "integer", "description" : "The rule order", "format" : "int32" }, "type" : { "type" : "string", "description" : "The rule type", "readOnly" : true, "enum" : [ "ASSET_GROUPS", "ASSETS", "SCAN_CONFIGURATIONS", "SCHEDULES", "SCANS", "FINDINGS", "REPORTS", "USERS", "ACCOUNTS", "AUDITS", "SCHEDULED_REPORTS", "MANAGED_REPORTS", "INTEGRATIONS", "COMPLIANCE", "TAGS", "VIEW_TEMPLATES", "SCAN_POLICIES", "SUBSCRIPTIONS", "SUBSCRIPTIONS_TEMPLATES", "TERMS", "TERMS_TEMPLATES", "APPLIANCES", "CUSTOMERS", "AGENTS", "CONSUMPTION", "WORKFLOWS", "CHECKS", "PRODUCT_INFORMATION", "FINDING_TEMPLATES", "MATCHES", "INFORMATION_PRODUCTS", "INFORMATION_PORTS", "INFORMATION_SERVICES", "INFORMATION_CERTIFICATES", "ENGAGEMENT_REQUESTS", "EVENT_SUBSCRIPTIONS", "AUTOMATION_RULES" ] }, "viewTemplate" : { "$ref" : "#/components/schemas/AutomationRule.ViewTemplate" }, "actions" : { "$ref" : "#/components/schemas/AutomationRule.Actions" }, "tags" : { "type" : "array", "description" : "The rule tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "AutomationRule.Actions" : { "type" : "object", "properties" : { "addTags" : { "type" : "array", "description" : "The rule tags to add", "items" : { "$ref" : "#/components/schemas/AutomationRule.Actions.Tag" } }, "removeTags" : { "type" : "array", "description" : "The rule tags to remove", "items" : { "$ref" : "#/components/schemas/AutomationRule.Actions.Tag" } }, "addAssetTags" : { "type" : "array", "description" : "The rule tags to add to asset", "items" : { "$ref" : "#/components/schemas/AutomationRule.Actions.Tag" } }, "removeAssetTags" : { "type" : "array", "description" : "The rule tags to remove from asset", "items" : { "$ref" : "#/components/schemas/AutomationRule.Actions.Tag" } } }, "description" : "The rule actions" }, "AutomationRule.Actions.Tag" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "key" : { "type" : "string" }, "value" : { "type" : "string" } }, "description" : "The rule tags to remove from asset" }, "AutomationRule.ViewTemplate" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AutomationRule.ViewTemplate.Filter" } } }, "description" : "The rule view template" }, "AutomationRule.ViewTemplate.Filter" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "comparison" : { "type" : "string" }, "value" : { "type" : "string" } } }, "CertificateCreationRequest" : { "type" : "object", "properties" : { "certificateSigningRequest" : { "type" : "string" }, "scannerId" : { "type" : "integer", "format" : "int64" }, "key" : { "type" : "string" }, "service" : { "type" : "string", "enum" : [ "OUTPOST24_GLOBAL", "OUTSCAN", "OPERATOR", "OUTSCAN_FRONTEND", "OUTSCAN_ADMIN", "OUTSCAN_BACKEND", "OUTSCAN_ATTACKER", "OUTSCAN_REMOTE_SUPPORT", "HIAB_SCHEDULER", "HIAB_SCANNER", "REPORT_SERVICE", "EVENT_SERVICE", "MESOTHELAE_JOBS", "MESOTHELAE_TASKS", "LIBELLUM", "TEDDY_SALAD", "AGENT", "MESOS_AGENT", "SWAT_API", "SWAT_WORKER", "SUPPORT" ] } } }, "Check" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The check id", "format" : "int32", "readOnly" : true }, "cve" : { "type" : "string", "description" : "The check CVE", "readOnly" : true }, "name" : { "type" : "string", "description" : "The check name", "readOnly" : true }, "nvdCvssV2Score" : { "type" : "number", "description" : "The CVSS V2 score", "format" : "double", "readOnly" : true }, "nvdCvssV3Score" : { "type" : "number", "description" : "The CVSS V3 score", "format" : "double", "readOnly" : true }, "nvdCvssV2Vector" : { "type" : "string", "description" : "The CVSS V2 vector", "readOnly" : true }, "cvssV3Severity" : { "type" : "string", "description" : "The CVSS V3 Severity", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "hasExploits" : { "type" : "boolean", "description" : "Set to true when exploits are available", "readOnly" : true }, "sans25" : { "type" : "integer", "description" : "The SANS 25 score", "format" : "int32", "readOnly" : true }, "cisaKev" : { "type" : "boolean", "description" : "Set to true when CVE is listed in CISA KEV catalog", "readOnly" : true }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "description" : { "type" : "string", "description" : "The check description", "readOnly" : true }, "cyrating" : { "type" : "number", "format" : "double", "readOnly" : true }, "previousCyrating" : { "type" : "number", "format" : "double", "readOnly" : true }, "cyratingDelta" : { "type" : "number", "format" : "double", "readOnly" : true }, "cyratingUpdated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "cyratingLastSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "exploitProbability" : { "type" : "number", "description" : "The exploit probability", "format" : "double", "readOnly" : true }, "previousExploitProbability" : { "type" : "number", "description" : "The previous exploit probability", "format" : "double", "readOnly" : true }, "exploitProbabilityDelta" : { "type" : "number", "description" : "The exploit probability delta", "format" : "double", "readOnly" : true }, "epssScore" : { "type" : "number", "description" : "The EPSS score", "format" : "double", "readOnly" : true }, "epssScoreDelta" : { "type" : "number", "description" : "The EPSS score delta", "format" : "double", "readOnly" : true }, "softwareComponent" : { "type" : "string", "description" : "The software component", "readOnly" : true }, "owasp2017" : { "type" : "array", "description" : "The OWASP 2017 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2017 scores", "format" : "int32", "readOnly" : true } }, "solutionType" : { "type" : "string", "description" : "The solution type", "readOnly" : true, "enum" : [ "NOT_CLASSIFIED", "UNKNOWN", "RECONFIGURE", "WORKAROUND", "SOLUTION_IN_PROGRESS", "CONTACT_VENDOR", "UPDATE", "PATCH", "NOT_ACKNOWLEDGED", "NO_SOLUTION", "CONFIGURE_ACCOUNT", "DISABLE", "FILTER", "MALWARE" ] }, "solution" : { "type" : "string", "description" : "The solution", "readOnly" : true }, "solutionProduct" : { "type" : "string", "description" : "The solution product", "readOnly" : true }, "solutionTitle" : { "type" : "string", "description" : "The solution title", "readOnly" : true }, "solutionUuid" : { "type" : "string", "description" : "The solution uuid", "readOnly" : true }, "bugTraq" : { "type" : "array", "description" : "The bug track", "readOnly" : true, "items" : { "type" : "integer", "description" : "The bug track", "format" : "int32", "readOnly" : true } }, "nvdCvssV3Vector" : { "type" : "string", "description" : "The CVSS V3 vector", "readOnly" : true }, "farsight" : { "$ref" : "#/components/schemas/Farsight" }, "classifications" : { "$ref" : "#/components/schemas/Classification.Classifications" } } }, "Classification.Classifications" : { "type" : "object", "properties" : { "sans25" : { "type" : "integer", "format" : "int32" }, "capec" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2004" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2007" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2010" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2013" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2017" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "owasp2021" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, "description" : "The classifications such as CAPEC, OWASP20XX", "readOnly" : true }, "Farsight" : { "type" : "object", "properties" : { "risk" : { "$ref" : "#/components/schemas/Farsight.Risk" }, "updated" : { "type" : "string", "format" : "date-time" }, "lastThreatActivity" : { "type" : "string", "format" : "date-time" } }, "description" : "The farsight concists in additional information on risk such as likelihood, threat activity", "readOnly" : true }, "Farsight.Risk" : { "type" : "object", "properties" : { "score" : { "type" : "number", "format" : "float" }, "delta" : { "type" : "number", "format" : "float" } } }, "Exploit" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "source" : { "type" : "string", "readOnly" : true, "enum" : [ "Unknown", "Core Security", "Immunity", "Exploit Database", "DSquare Security", "Contagio", "Metasploit", "SAINT", "Security Focus", "Snort", "Farsight" ] }, "cve" : { "type" : "string", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "pack" : { "type" : "string", "readOnly" : true }, "checkId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "url" : { "type" : "string", "readOnly" : true } } }, "Classification" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "cwe" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "sans25" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "capec" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2004" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2007" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2010" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2013" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2017" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "owasp2021" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "secureCodeWarrior" : { "$ref" : "#/components/schemas/SecureCodeWarrior" }, "classifications" : { "$ref" : "#/components/schemas/Classification.Classifications" } } }, "SecureCodeWarrior" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "url" : { "type" : "string" } }, "description" : "The secure code warrior information on the vulnerability description and training", "readOnly" : true }, "ComplianceFinding" : { "required" : [ "assetId", "matchId", "requirementId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "requirementId" : { "type" : "integer", "description" : "Id of the requirement associated with the finding", "format" : "int32" }, "matchId" : { "type" : "integer", "description" : "Id of the matching entity", "format" : "int32" }, "assetId" : { "type" : "integer", "description" : "Id of the associated asset", "format" : "int32" }, "policyId" : { "type" : "integer", "description" : "Id of the associated policy", "format" : "int32", "readOnly" : true }, "policyName" : { "type" : "string", "description" : "Name of the associated policy", "readOnly" : true }, "audit" : { "type" : "string", "description" : "Audit information related to the finding", "readOnly" : true }, "description" : { "type" : "string", "description" : "Description of the finding", "readOnly" : true }, "rationale" : { "type" : "string", "description" : "Rationale behind the finding", "readOnly" : true }, "scored" : { "type" : "boolean", "description" : "Indicates whether the finding is scored", "readOnly" : true }, "nameLong" : { "type" : "string", "description" : "Long name associated with the finding", "readOnly" : true }, "nameShort" : { "type" : "string", "description" : "Short name associated with the finding", "readOnly" : true }, "requirement" : { "type" : "string", "description" : "Requirement details associated with the finding", "readOnly" : true }, "solution" : { "type" : "string", "description" : "Solution to address the finding", "readOnly" : true }, "impacts" : { "type" : "string", "description" : "Impacts of the finding", "readOnly" : true }, "notes" : { "type" : "string", "description" : "Additional notes related to the finding", "readOnly" : true }, "references" : { "type" : "string", "description" : "References related to the finding", "readOnly" : true }, "controls" : { "type" : "string", "description" : "Controls in place to address the finding", "readOnly" : true }, "category" : { "type" : "string", "description" : "Category of compliance requirement", "readOnly" : true, "enum" : [ "INFRASTRUCTURE", "COMPUTE", "NETWORK", "STORAGE", "DATABASE", "BIG_DATA_AND_ANALYTICS", "SECURITY_AND_IDENTITY", "MONITORING_AND_LOGGING", "NOT_DEFINED" ] }, "source" : { "type" : "array", "description" : "Array of sources related to the finding", "readOnly" : true, "items" : { "type" : "string", "description" : "Array of sources related to the finding", "readOnly" : true, "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "firstSeen" : { "type" : "string", "description" : "Instant when the finding was first seen", "format" : "date-time", "readOnly" : true }, "lastSeen" : { "type" : "string", "description" : "Instant when the finding was last seen", "format" : "date-time", "readOnly" : true }, "firstScanId" : { "type" : "integer", "description" : "Id of the first scan associated with the finding", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "description" : "Id of the last scan associated with the finding", "format" : "int32", "readOnly" : true }, "compliant" : { "type" : "string", "description" : "Compliance status of the finding", "readOnly" : true, "enum" : [ "COMPLIANT", "NOT_COMPLIANT", "COMPLIANT_WITH_EXCEPTIONS" ] }, "falsePositive" : { "type" : "string", "description" : "Instant when the finding was marked as false positive", "format" : "date-time", "readOnly" : true }, "falsePositiveComment" : { "type" : "string", "description" : "Comment related to marking the finding as false positive", "readOnly" : true }, "falsePositiveBy" : { "type" : "string", "description" : "User who marked the finding as false positive", "readOnly" : true }, "exception" : { "type" : "string", "description" : "Instant when an exception was recorded for the finding", "format" : "date-time", "readOnly" : true }, "exceptionComment" : { "type" : "string", "description" : "Comment related to the exception recorded for the finding", "readOnly" : true }, "exceptionUntil" : { "type" : "string", "description" : "Instant until when the exception is valid", "format" : "date-time", "readOnly" : true }, "exceptionBy" : { "type" : "string", "description" : "User who recorded the exception for the finding", "readOnly" : true }, "humanCheck" : { "type" : "boolean", "description" : "Indicates whether there is a human check for the finding", "readOnly" : true }, "firstFailed" : { "type" : "string", "description" : "Instant when the finding first failed", "format" : "date-time", "readOnly" : true }, "lastFailed" : { "type" : "string", "description" : "Instant when the finding last failed", "format" : "date-time", "readOnly" : true }, "assetName" : { "type" : "string", "description" : "Name of the asset associated with the finding", "readOnly" : true }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Policy" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "description" : { "type" : "string", "readOnly" : true }, "type" : { "type" : "string", "readOnly" : true, "enum" : [ "AWS", "GCP", "AZURE" ] }, "checksum" : { "type" : "string", "format" : "byte", "readOnly" : true } } }, "Requirement" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "policyId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "audit" : { "type" : "string", "readOnly" : true }, "description" : { "type" : "string", "readOnly" : true }, "rationale" : { "type" : "string", "readOnly" : true }, "scored" : { "type" : "boolean", "readOnly" : true }, "nameLong" : { "type" : "string", "readOnly" : true }, "nameShort" : { "type" : "string", "readOnly" : true }, "requirementId" : { "type" : "string", "readOnly" : true }, "solution" : { "type" : "string", "readOnly" : true }, "category" : { "type" : "string", "readOnly" : true, "enum" : [ "INFRASTRUCTURE", "COMPUTE", "NETWORK", "STORAGE", "DATABASE", "BIG_DATA_AND_ANALYTICS", "SECURITY_AND_IDENTITY", "MONITORING_AND_LOGGING", "NOT_DEFINED" ] }, "notes" : { "type" : "string", "readOnly" : true }, "references" : { "type" : "string", "readOnly" : true }, "controls" : { "type" : "string", "readOnly" : true }, "impacts" : { "type" : "string", "readOnly" : true } } }, "ComplianceFindingException" : { "required" : [ "exceptionUntil" ], "type" : "object", "properties" : { "exceptionUntil" : { "type" : "string", "format" : "date-time" }, "exceptionComment" : { "type" : "string" } } }, "ComplianceFindingFalsePositive" : { "required" : [ "falsePositiveComment" ], "type" : "object", "properties" : { "falsePositiveComment" : { "minLength" : 1, "type" : "string" } } }, "ComplianceReport" : { "required" : [ "format", "name" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "format" : { "type" : "string", "enum" : [ "PDF", "EXCEL", "XML", "SWATDEMO" ] }, "password" : { "type" : "string" }, "zip" : { "type" : "boolean" }, "level" : { "type" : "string", "enum" : [ "Detailed", "Management", "Summary" ] }, "assetIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "assetGroupIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "tagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "filter" : { "type" : "string" }, "viewTemplateId" : { "type" : "integer", "format" : "int32" }, "deliveryMethod" : { "$ref" : "#/components/schemas/DeliveryMethod" } } }, "DeliveryMethod" : { "type" : "object", "properties" : { "email" : { "$ref" : "#/components/schemas/DeliveryMethod.Email" }, "managedReport" : { "$ref" : "#/components/schemas/DeliveryMethod.ManagedReport" } }, "description" : "Method used to deliver the report" }, "DeliveryMethod.Email" : { "type" : "object", "properties" : { "userIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "recipients" : { "$ref" : "#/components/schemas/DeliveryMethod.Recipients" } } }, "DeliveryMethod.ManagedReport" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "tags" : { "type" : "string" } } }, "DeliveryMethod.Recipients" : { "type" : "object", "properties" : { "addresses" : { "type" : "array", "items" : { "type" : "string" } }, "pgpKey" : { "type" : "string" } } }, "ConsumptionStats" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "readOnly" : true }, "organization" : { "type" : "string", "readOnly" : true }, "salesAccountId" : { "type" : "string", "readOnly" : true }, "periodStart" : { "type" : "string", "description" : "The consumption period start date", "format" : "date-time" }, "periodEnd" : { "type" : "string", "description" : "The consumption period end date", "format" : "date-time" }, "appliancePeriodEnd" : { "type" : "string", "description" : "The appliance consumption period start date", "format" : "date-time" }, "netsecAssets" : { "type" : "integer", "description" : "The netsec assets", "format" : "int32" }, "netsecScans" : { "type" : "integer", "description" : "The netsec scans", "format" : "int32" }, "netsecInternalAssets" : { "type" : "integer", "description" : "The netsec internal assets", "format" : "int32" }, "netsecInternalScans" : { "type" : "integer", "description" : "The netsec internal scans", "format" : "int32" }, "netsecApplianceAssets" : { "type" : "integer", "description" : "The netsec appliance assets", "format" : "int32" }, "netsecApplianceScans" : { "type" : "integer", "description" : "The netsec appliance scans", "format" : "int32" }, "netsecApplianceExternalAssets" : { "type" : "integer", "description" : "The netsec appliance external assets", "format" : "int32" }, "netsecApplianceExternalScans" : { "type" : "integer", "description" : "The netsec appliance external scans", "format" : "int32" }, "complianceAssets" : { "type" : "integer", "description" : "The compliance assets", "format" : "int32" }, "complianceScans" : { "type" : "integer", "description" : "The compliance scans", "format" : "int32" }, "complianceInternalAssets" : { "type" : "integer", "description" : "The compliance internal assets", "format" : "int32" }, "complianceInternalScans" : { "type" : "integer", "description" : "The compliance internal scans", "format" : "int32" }, "complianceApplianceAssets" : { "type" : "integer", "description" : "The compliance appliance assets", "format" : "int32" }, "complianceApplianceScans" : { "type" : "integer", "description" : "The compliance appliance scans", "format" : "int32" }, "complianceApplianceExternalAssets" : { "type" : "integer", "description" : "The compliance appliance external assets", "format" : "int32" }, "complianceApplianceExternalScans" : { "type" : "integer", "description" : "The compliance appliance external scans", "format" : "int32" }, "pciAssets" : { "type" : "integer", "description" : "The pci assets", "format" : "int32" }, "pciScans" : { "type" : "integer", "description" : "The pci scans", "format" : "int32" }, "scaleAssets" : { "type" : "integer", "description" : "The scale assets", "format" : "int32" }, "scaleScans" : { "type" : "integer", "description" : "The scale scans", "format" : "int32" }, "scaleInternalAssets" : { "type" : "integer", "description" : "The scale internal assets", "format" : "int32" }, "scaleApplianceAssets" : { "type" : "integer", "description" : "The scale appliance assets", "format" : "int32" }, "scaleApplianceScans" : { "type" : "integer", "description" : "The scale appliance scans", "format" : "int32" }, "scaleApplianceExternalScans" : { "type" : "integer", "description" : "The scale appliance external scans", "format" : "int32" }, "scaleApplianceExternalAssets" : { "type" : "integer", "description" : "The scale appliance external assets", "format" : "int32" }, "cloudsecAssets" : { "type" : "integer", "description" : "The cloudsec assets", "format" : "int32" }, "cloudsecScans" : { "type" : "integer", "description" : "The cloudsec scans", "format" : "int32" }, "networkDiscoveryScans" : { "type" : "integer", "description" : "The network discovery scans", "format" : "int32" }, "networkDiscoveryApplianceScans" : { "type" : "integer", "description" : "The network discovery appliance scans", "format" : "int32" }, "networkLookups" : { "type" : "integer", "description" : "The network lookups", "format" : "int32" }, "networkApplianceLookups" : { "type" : "integer", "description" : "The network appliance lookups", "format" : "int32" }, "cloudDiscoveryScans" : { "type" : "integer", "description" : "The cloud discovery scans", "format" : "int32" }, "cloudDiscoveryApplianceScans" : { "type" : "integer", "description" : "The cloud discovery appliance scans", "format" : "int32" }, "networkAssets" : { "type" : "integer", "description" : "The network assets", "format" : "int32" }, "networkScans" : { "type" : "integer", "description" : "The network scans", "format" : "int32" }, "networkApplianceAssets" : { "type" : "integer", "description" : "The network appliance assets", "format" : "int32" }, "networkApplianceScans" : { "type" : "integer", "description" : "The network appliance scans", "format" : "int32" }, "dockerImageDiscoveryScans" : { "type" : "integer", "description" : "The docker image discovery scans", "format" : "int32" }, "dockerImageAssets" : { "type" : "integer", "description" : "The docker image assets", "format" : "int32" }, "dockerImageScans" : { "type" : "integer", "description" : "The docker image scans", "format" : "int32" }, "dockerImageDiscoveryApplianceScans" : { "type" : "integer", "description" : "The docker image discovery appliance scans", "format" : "int32" }, "dockerImageApplianceAssets" : { "type" : "integer", "description" : "The docker image appliance assets", "format" : "int32" }, "dockerImageApplianceScans" : { "type" : "integer", "description" : "The docker image appliance scans", "format" : "int32" }, "outscanNXAssets" : { "type" : "integer", "description" : "The outscan NX assets", "format" : "int32" }, "outscanNXApplianceAssets" : { "type" : "integer", "description" : "The outscan NX appliance assets", "format" : "int32" } } }, "CredentialClass" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "hidden" : { "type" : "boolean", "readOnly" : true } } }, "Customer" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "readOnly" : true }, "updatedBy" : { "type" : "string", "readOnly" : true }, "createdById" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string" }, "country" : { "type" : "string", "readOnly" : true }, "active" : { "type" : "boolean", "readOnly" : true }, "features" : { "type" : "array", "items" : { "type" : "string" } }, "awsExternalId" : { "type" : "string", "readOnly" : true }, "uuid" : { "type" : "string", "readOnly" : true }, "organization" : { "type" : "string", "readOnly" : true }, "organizationUuid" : { "type" : "string", "readOnly" : true }, "farsightProducts" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true } }, "salesAccountId" : { "type" : "string", "readOnly" : true }, "assetMigration" : { "type" : "string", "format" : "date-time" }, "migrationStatus" : { "type" : "string", "description" : "The migration status", "readOnly" : true, "enum" : [ "RUNNING", "FINISHED", "FAILED" ] }, "state" : { "type" : "string", "readOnly" : true }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "migration" : { "$ref" : "#/components/schemas/Customer.Migration" } } }, "Customer.Migration" : { "type" : "object", "properties" : { "queued" : { "type" : "string", "format" : "date-time" }, "started" : { "type" : "string", "format" : "date-time" }, "ended" : { "type" : "string", "format" : "date-time" }, "failed" : { "type" : "boolean" }, "targets" : { "type" : "integer", "format" : "int32" }, "migratedTargets" : { "type" : "integer", "format" : "int32" }, "targetGroups" : { "type" : "integer", "format" : "int32" }, "migratedTargetGroups" : { "type" : "integer", "format" : "int32" }, "reports" : { "type" : "integer", "format" : "int32" }, "migratedReports" : { "type" : "integer", "format" : "int32" }, "managedReports" : { "type" : "integer", "format" : "int32" }, "migratedManagedReports" : { "type" : "integer", "format" : "int32" } }, "description" : "The migration status", "readOnly" : true }, "UsageStats" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "readOnly" : true }, "organization" : { "type" : "string", "readOnly" : true }, "salesAccountId" : { "type" : "string", "readOnly" : true }, "statsUpdated" : { "type" : "string", "format" : "date-time" }, "applianceStatsUpdated" : { "type" : "string", "format" : "date-time" }, "scaleConfigurations" : { "type" : "integer", "format" : "int32" }, "scoutConfigurations" : { "type" : "integer", "format" : "int32" }, "cloudsecConfigurations" : { "type" : "integer", "format" : "int32" }, "applianceScaleConfigurations" : { "type" : "integer", "format" : "int32" }, "users" : { "type" : "integer", "format" : "int32" }, "lastLogin" : { "type" : "string", "format" : "date-time" }, "applianceUsers" : { "type" : "integer", "format" : "int32" }, "applianceLastLogin" : { "type" : "string", "format" : "date-time" }, "findingsCritical" : { "type" : "integer", "format" : "int32" }, "findingsHigh" : { "type" : "integer", "format" : "int32" }, "findingsMedium" : { "type" : "integer", "format" : "int32" }, "findingsLow" : { "type" : "integer", "format" : "int32" }, "findingsRecommendations" : { "type" : "integer", "format" : "int32" }, "applianceFindingsCritical" : { "type" : "integer", "format" : "int32" }, "applianceFindingsHigh" : { "type" : "integer", "format" : "int32" }, "applianceFindingsMedium" : { "type" : "integer", "format" : "int32" }, "applianceFindingsLow" : { "type" : "integer", "format" : "int32" }, "applianceFindingsRecommendations" : { "type" : "integer", "format" : "int32" }, "scans" : { "type" : "integer", "format" : "int32" }, "lastScan" : { "type" : "string", "format" : "date-time" }, "applianceScans" : { "type" : "integer", "format" : "int32" }, "applianceLastScan" : { "type" : "string", "format" : "date-time" }, "accountsAws" : { "type" : "integer", "format" : "int32" }, "accountsGcp" : { "type" : "integer", "format" : "int32" }, "accountsAzure" : { "type" : "integer", "format" : "int32" }, "accountsVsphere" : { "type" : "integer", "format" : "int32" }, "accountsBasic" : { "type" : "integer", "format" : "int32" }, "accountsWeb" : { "type" : "integer", "format" : "int32" }, "applianceAccountsAws" : { "type" : "integer", "format" : "int32" }, "applianceAccountsGcp" : { "type" : "integer", "format" : "int32" }, "applianceAccountsAzure" : { "type" : "integer", "format" : "int32" }, "applianceAccountsVsphere" : { "type" : "integer", "format" : "int32" }, "applianceAccountsBasic" : { "type" : "integer", "format" : "int32" }, "applianceAccountsWeb" : { "type" : "integer", "format" : "int32" }, "cyr3conAssets" : { "type" : "integer", "format" : "int32" }, "cyr3conApplianceAssets" : { "type" : "integer", "format" : "int32" }, "agents" : { "type" : "integer", "format" : "int32" }, "agentsScanned" : { "type" : "integer", "format" : "int32" }, "agentsOutdated" : { "type" : "integer", "format" : "int32" }, "applianceAgents" : { "type" : "integer", "format" : "int32" }, "applianceAgentsScanned" : { "type" : "integer", "format" : "int32" }, "applianceAgentsOutdated" : { "type" : "integer", "format" : "int32" } } }, "Cve" : { "required" : [ "cve" ], "type" : "object", "properties" : { "cve" : { "minLength" : 1, "type" : "string", "description" : "The CVE identifier" }, "cisaActionDue" : { "type" : "string", "description" : "CISA action due date", "format" : "date-time" }, "cisaExploitAdd" : { "type" : "string", "description" : "CISA exploit add date", "format" : "date-time" }, "cisaRequiredAction" : { "type" : "string", "description" : "CISA required action" }, "cisaVulnerabilityName" : { "maxLength" : 256, "minLength" : 0, "type" : "string", "description" : "CISA vulnerability name" }, "evaluatorComment" : { "type" : "string", "description" : "Evaluator comment" }, "evaluatorImpact" : { "type" : "string", "description" : "Evaluator impact assessment" }, "evaluatorSolution" : { "type" : "string", "description" : "Evaluator solution" }, "lastModified" : { "type" : "string", "description" : "Last modified date", "format" : "date-time" }, "published" : { "type" : "string", "description" : "Published date", "format" : "date-time" }, "sourceIdentifier" : { "maxLength" : 64, "minLength" : 0, "type" : "string", "description" : "Source identifier" }, "vulnStatus" : { "maxLength" : 64, "minLength" : 0, "type" : "string", "description" : "Vulnerability status" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "previousFarsightScore" : { "type" : "number", "description" : "Farsight score (previous)", "format" : "double" }, "previousEpssScore" : { "type" : "number", "description" : "EPSS score (previous)", "format" : "double" }, "hasExploits" : { "type" : "boolean", "description" : "Whether the CVE has exploits" }, "cisa" : { "$ref" : "#/components/schemas/Cve.Cisa" }, "configurations" : { "type" : "array", "description" : "Vulnerability configurations", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Configuration" } }, "counters" : { "$ref" : "#/components/schemas/Cve.Counters" }, "cveTags" : { "type" : "array", "description" : "CVE tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.CveTag" } }, "descriptions" : { "type" : "array", "description" : "Vulnerability descriptions", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Description" } }, "epss" : { "type" : "array", "description" : "EPSS information", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Epss" } }, "exploits" : { "type" : "array", "description" : "Exploits information", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Exploit" } }, "lastUpdateChanges" : { "$ref" : "#/components/schemas/Cve.LastUpdateChanges" }, "metrics" : { "$ref" : "#/components/schemas/Cve.Metrics" }, "references" : { "type" : "array", "description" : "References", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Reference" } }, "scores" : { "$ref" : "#/components/schemas/Cve.Scores" }, "vendorComments" : { "type" : "array", "description" : "Vendor comments", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.VendorComment" } }, "weaknesses" : { "type" : "array", "description" : "Weakness information", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Weakness" } }, "farsightScore" : { "type" : "number", "description" : "Farsight score (first entry)", "format" : "double", "readOnly" : true }, "epssScore" : { "type" : "number", "description" : "EPSS score (first entry)", "format" : "double", "readOnly" : true }, "farsight" : { "$ref" : "#/components/schemas/Cve.FarsightData" }, "lastAddedExploits" : { "type" : "array", "description" : "Exploits added in the last update", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Cve.Exploit" } } } }, "Cve.Cisa" : { "type" : "object", "properties" : { "vendorProject" : { "type" : "string" }, "product" : { "type" : "string" }, "vulnerabilityName" : { "type" : "string" }, "dateAdded" : { "type" : "string", "format" : "date-time" }, "dueDate" : { "type" : "string", "format" : "date-time" }, "shortDescription" : { "type" : "string" }, "requiredAction" : { "type" : "string" }, "knownRansomwareCampaignUse" : { "type" : "string" }, "notes" : { "type" : "string" } }, "description" : "CISA information", "readOnly" : true }, "Cve.Configuration" : { "type" : "object", "properties" : { "negate" : { "type" : "boolean" }, "operator" : { "type" : "string" }, "nodes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Configuration.Node" } } }, "description" : "Vulnerability configurations", "readOnly" : true }, "Cve.Configuration.CpeMatch" : { "type" : "object", "properties" : { "criteria" : { "type" : "string" }, "matchCriteriaId" : { "type" : "string" }, "versionEndExcluding" : { "type" : "string" }, "versionEndIncluding" : { "type" : "string" }, "versionStartExcluding" : { "type" : "string" }, "versionStartIncluding" : { "type" : "string" }, "vulnerable" : { "type" : "boolean" } } }, "Cve.Configuration.Node" : { "type" : "object", "properties" : { "cpeMatch" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Configuration.CpeMatch" } }, "negate" : { "type" : "boolean" }, "operator" : { "type" : "string" } } }, "Cve.Counters" : { "type" : "object", "properties" : { "campaigns" : { "type" : "integer", "format" : "int32" }, "exploits" : { "type" : "integer", "format" : "int32" }, "malware" : { "type" : "integer", "format" : "int32" }, "threatActors" : { "type" : "integer", "format" : "int32" }, "tools" : { "type" : "integer", "format" : "int32" } }, "description" : "Vulnerability counters", "readOnly" : true }, "Cve.CveTag" : { "type" : "object", "properties" : { "sourceIdentifier" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "type" : "string" } } }, "description" : "CVE tags", "readOnly" : true }, "Cve.Description" : { "type" : "object", "properties" : { "lang" : { "type" : "string" }, "value" : { "type" : "string" } } }, "Cve.Epss" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time" }, "percentile" : { "type" : "number", "format" : "double" }, "score" : { "type" : "number", "format" : "double" } }, "description" : "EPSS information", "readOnly" : true }, "Cve.Exploit" : { "type" : "object", "properties" : { "aliases" : { "type" : "array", "items" : { "type" : "string" } }, "applicationUrl" : { "type" : "string" }, "author" : { "type" : "string" }, "codes" : { "type" : "array", "items" : { "type" : "string" } }, "dateAdded" : { "type" : "string" }, "datePublished" : { "type" : "string" }, "dateUpdated" : { "type" : "string" }, "description" : { "type" : "string" }, "externalId" : { "type" : "integer", "format" : "int32" }, "file" : { "type" : "string" }, "platform" : { "type" : "string" }, "port" : { "type" : "string" }, "screenshotUrl" : { "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "type" : { "type" : "string" }, "verified" : { "type" : "boolean" } }, "description" : "Exploits added in the last update", "readOnly" : true }, "Cve.FarsightData" : { "type" : "object", "properties" : { "risk" : { "$ref" : "#/components/schemas/Cve.FarsightData.Risk" }, "updated" : { "type" : "string" }, "lastThreatActivity" : { "type" : "string" } }, "description" : "Farsight data structure", "readOnly" : true }, "Cve.FarsightData.Risk" : { "type" : "object", "properties" : { "score" : { "type" : "number", "format" : "double" }, "delta" : { "type" : "number", "format" : "double" } } }, "Cve.FarsightScore" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time" }, "popularityScore" : { "type" : "number", "format" : "double" }, "score" : { "type" : "number", "format" : "double" } } }, "Cve.LastUpdateChanges" : { "type" : "object", "properties" : { "exploits" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, "description" : "Changes from the last update (e.g., newly added exploits)", "readOnly" : true }, "Cve.Metrics" : { "type" : "object", "properties" : { "cvssMetricV2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssMetricV2" } }, "cvssMetricV30" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssMetricV30" } }, "cvssMetricV31" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssMetricV31" } }, "cvssMetricV40" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssMetricV40" } } }, "description" : "Vulnerability metrics", "readOnly" : true }, "Cve.Metrics.CvssDataV2" : { "type" : "object", "properties" : { "accessComplexity" : { "type" : "string" }, "accessVector" : { "type" : "string" }, "authentication" : { "type" : "string" }, "availabilityImpact" : { "type" : "string" }, "availabilityRequirement" : { "type" : "string" }, "baseScore" : { "type" : "number", "format" : "double" }, "collateralDamagePotential" : { "type" : "string" }, "confidentialityImpact" : { "type" : "string" }, "confidentialityRequirement" : { "type" : "string" }, "environmentalScore" : { "type" : "number", "format" : "double" }, "exploitability" : { "type" : "string" }, "integrityImpact" : { "type" : "string" }, "integrityRequirement" : { "type" : "string" }, "remediationLevel" : { "type" : "string" }, "reportConfidence" : { "type" : "string" }, "targetDistribution" : { "type" : "string" }, "temporalScore" : { "type" : "number", "format" : "double" }, "vectorString" : { "type" : "string" }, "version" : { "type" : "string" } } }, "Cve.Metrics.CvssDataV30" : { "type" : "object", "properties" : { "attackComplexity" : { "type" : "string" }, "attackVector" : { "type" : "string" }, "availabilityImpact" : { "type" : "string" }, "availabilityRequirement" : { "type" : "string" }, "baseScore" : { "type" : "number", "format" : "double" }, "baseSeverity" : { "type" : "string" }, "confidentialityImpact" : { "type" : "string" }, "confidentialityRequirement" : { "type" : "string" }, "environmentalScore" : { "type" : "number", "format" : "double" }, "environmentalSeverity" : { "type" : "string" }, "exploitCodeMaturity" : { "type" : "string" }, "integrityImpact" : { "type" : "string" }, "integrityRequirement" : { "type" : "string" }, "modifiedAttackComplexity" : { "type" : "string" }, "modifiedAttackVector" : { "type" : "string" }, "modifiedAvailabilityImpact" : { "type" : "string" }, "modifiedConfidentialityImpact" : { "type" : "string" }, "modifiedIntegrityImpact" : { "type" : "string" }, "modifiedPrivilegesRequired" : { "type" : "string" }, "modifiedScope" : { "type" : "string" }, "modifiedUserInteraction" : { "type" : "string" }, "privilegesRequired" : { "type" : "string" }, "remediationLevel" : { "type" : "string" }, "reportConfidence" : { "type" : "string" }, "scope" : { "type" : "string" }, "temporalScore" : { "type" : "number", "format" : "double" }, "temporalSeverity" : { "type" : "string" }, "userInteraction" : { "type" : "string" }, "vectorString" : { "type" : "string" }, "version" : { "type" : "string" } } }, "Cve.Metrics.CvssDataV31" : { "type" : "object", "properties" : { "attackComplexity" : { "type" : "string" }, "attackVector" : { "type" : "string" }, "availabilityImpact" : { "type" : "string" }, "availabilityRequirement" : { "type" : "string" }, "baseScore" : { "type" : "number", "format" : "double" }, "baseSeverity" : { "type" : "string" }, "confidentialityImpact" : { "type" : "string" }, "confidentialityRequirement" : { "type" : "string" }, "environmentalScore" : { "type" : "number", "format" : "double" }, "environmentalSeverity" : { "type" : "string" }, "exploitCodeMaturity" : { "type" : "string" }, "integrityImpact" : { "type" : "string" }, "integrityRequirement" : { "type" : "string" }, "modifiedAttackComplexity" : { "type" : "string" }, "modifiedAttackVector" : { "type" : "string" }, "modifiedAvailabilityImpact" : { "type" : "string" }, "modifiedConfidentialityImpact" : { "type" : "string" }, "modifiedIntegrityImpact" : { "type" : "string" }, "modifiedPrivilegesRequired" : { "type" : "string" }, "modifiedScope" : { "type" : "string" }, "modifiedUserInteraction" : { "type" : "string" }, "privilegesRequired" : { "type" : "string" }, "remediationLevel" : { "type" : "string" }, "reportConfidence" : { "type" : "string" }, "scope" : { "type" : "string" }, "temporalScore" : { "type" : "number", "format" : "double" }, "temporalSeverity" : { "type" : "string" }, "userInteraction" : { "type" : "string" }, "vectorString" : { "type" : "string" }, "version" : { "type" : "string" } } }, "Cve.Metrics.CvssDataV40" : { "type" : "object", "properties" : { "attackComplexity" : { "type" : "string" }, "attackRequirements" : { "type" : "string" }, "attackVector" : { "type" : "string" }, "automatable" : { "type" : "string" }, "availabilityRequirement" : { "type" : "string" }, "baseScore" : { "type" : "number", "format" : "double" }, "baseSeverity" : { "type" : "string" }, "confidentialityRequirement" : { "type" : "string" }, "environmentalScore" : { "type" : "number", "format" : "double" }, "environmentalSeverity" : { "type" : "string" }, "exploitMaturity" : { "type" : "string" }, "integrityRequirement" : { "type" : "string" }, "modifiedAttackComplexity" : { "type" : "string" }, "modifiedAttackRequirements" : { "type" : "string" }, "modifiedAttackVector" : { "type" : "string" }, "modifiedPrivilegesRequired" : { "type" : "string" }, "modifiedSubAvailabilityImpact" : { "type" : "string" }, "modifiedSubConfidentialityImpact" : { "type" : "string" }, "modifiedSubIntegrityImpact" : { "type" : "string" }, "modifiedUserInteraction" : { "type" : "string" }, "modifiedVulnAvailabilityImpact" : { "type" : "string" }, "modifiedVulnConfidentialityImpact" : { "type" : "string" }, "modifiedVulnIntegrityImpact" : { "type" : "string" }, "privilegesRequired" : { "type" : "string" }, "providerUrgency" : { "type" : "string" }, "recovery" : { "type" : "string" }, "safety" : { "type" : "string" }, "subAvailabilityImpact" : { "type" : "string" }, "subConfidentialityImpact" : { "type" : "string" }, "subIntegrityImpact" : { "type" : "string" }, "threatScore" : { "type" : "number", "format" : "double" }, "threatSeverity" : { "type" : "string" }, "userInteraction" : { "type" : "string" }, "valueDensity" : { "type" : "string" }, "vectorString" : { "type" : "string" }, "version" : { "type" : "string" }, "vulnAvailabilityImpact" : { "type" : "string" }, "vulnConfidentialityImpact" : { "type" : "string" }, "vulnIntegrityImpact" : { "type" : "string" }, "vulnerabilityResponseEffort" : { "type" : "string" } } }, "Cve.Metrics.CvssMetricV2" : { "type" : "object", "properties" : { "acInsufInfo" : { "type" : "boolean" }, "baseSeverity" : { "type" : "string" }, "cvssData" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssDataV2" }, "exploitabilityScore" : { "type" : "number", "format" : "double" }, "impactScore" : { "type" : "number", "format" : "double" }, "obtainAllPrivilege" : { "type" : "boolean" }, "obtainOtherPrivilege" : { "type" : "boolean" }, "obtainUserPrivilege" : { "type" : "boolean" }, "source" : { "type" : "string" }, "type" : { "type" : "string" }, "userInteractionRequired" : { "type" : "boolean" } } }, "Cve.Metrics.CvssMetricV30" : { "type" : "object", "properties" : { "cvssData" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssDataV30" }, "exploitabilityScore" : { "type" : "number", "format" : "double" }, "impactScore" : { "type" : "number", "format" : "double" }, "source" : { "type" : "string" }, "type" : { "type" : "string" } } }, "Cve.Metrics.CvssMetricV31" : { "type" : "object", "properties" : { "cvssData" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssDataV31" }, "exploitabilityScore" : { "type" : "number", "format" : "double" }, "impactScore" : { "type" : "number", "format" : "double" }, "source" : { "type" : "string" }, "type" : { "type" : "string" } } }, "Cve.Metrics.CvssMetricV40" : { "type" : "object", "properties" : { "cvssData" : { "$ref" : "#/components/schemas/Cve.Metrics.CvssDataV40" }, "source" : { "type" : "string" }, "type" : { "type" : "string" } } }, "Cve.Reference" : { "type" : "object", "properties" : { "source" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "url" : { "type" : "string" } }, "description" : "References", "readOnly" : true }, "Cve.Scores" : { "type" : "object", "properties" : { "farsight_scores" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.FarsightScore" } } }, "description" : "Vulnerability scores", "readOnly" : true }, "Cve.VendorComment" : { "type" : "object", "properties" : { "organization" : { "type" : "string" }, "comment" : { "type" : "string" }, "lastModified" : { "type" : "string" } }, "description" : "Vendor comments", "readOnly" : true }, "Cve.Weakness" : { "type" : "object", "properties" : { "source" : { "type" : "string" }, "type" : { "type" : "string" }, "description" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cve.Description" } } }, "description" : "Weakness information", "readOnly" : true }, "Dashboard" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "cards" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Dashboard.Card" } }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Dashboard.Card" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "data" : { "type" : "string" }, "width" : { "type" : "integer", "format" : "int32" }, "height" : { "type" : "integer", "format" : "int32" }, "x" : { "type" : "integer", "format" : "int32" }, "y" : { "type" : "integer", "format" : "int32" } } }, "SupportListRequest" : { "required" : [ "prefix", "reason", "service", "tenant" ], "type" : "object", "properties" : { "service" : { "minLength" : 1, "type" : "string" }, "tenant" : { "type" : "string", "format" : "uuid" }, "prefix" : { "minLength" : 1, "type" : "string" }, "reason" : { "minLength" : 1, "type" : "string" } } }, "FormDataContentDisposition" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "fileName" : { "type" : "string" }, "creationDate" : { "type" : "string", "format" : "date-time" }, "modificationDate" : { "type" : "string", "format" : "date-time" }, "readDate" : { "type" : "string", "format" : "date-time" }, "size" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" } } }, "ObjectDecryptionRequest" : { "required" : [ "auditComment", "bucket", "key" ], "type" : "object", "properties" : { "bucket" : { "minLength" : 1, "type" : "string" }, "key" : { "minLength" : 1, "type" : "string" }, "unsigned" : { "type" : "boolean" }, "auditComment" : { "minLength" : 1, "type" : "string" } } }, "DownloadCacheEntry" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "key" : { "type" : "string", "readOnly" : true }, "status" : { "type" : "string", "readOnly" : true }, "size" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "token" : { "type" : "string", "readOnly" : true }, "tokenExpires" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "type" : { "type" : "string", "readOnly" : true, "enum" : [ "ATTACHMENT", "REPORT", "BLUEPRINT", "INTERNAL_BLUEPRINT", "MANAGED_REPORT", "DECRYPTED_OBJECT", "LOGS", "AGENT_INSTALLER", "UPDATE_PACKAGE", "SUPPORT_BUNDLE" ] } } }, "EngagementRequest" : { "required" : [ "status", "subscriptionType" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "status" : { "type" : "string", "description" : "The status of the engagement request", "enum" : [ "NEW", "IN_REVIEW", "MISSING_INFORMATION", "SCHEDULED", "DONE", "CANCELLED" ] }, "assetGroupId" : { "type" : "integer", "description" : "The associated asset group ID", "format" : "int32" }, "subscriptionType" : { "type" : "string", "description" : "The engagement request's subscription type", "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] }, "mainUrl" : { "type" : "string", "description" : "The main URL of the application to be assessed" }, "instances" : { "type" : "string", "description" : "The instances the application runs on" }, "accountIds" : { "type" : "array", "description" : "The account IDs associated with the engagement request", "items" : { "type" : "integer", "description" : "The account IDs associated with the engagement request", "format" : "int32" } }, "applicationName" : { "type" : "string", "description" : "The name of the application" }, "applicationServices" : { "type" : "string", "description" : "The services of the application" }, "applicationTypes" : { "type" : "array", "description" : "The types of the application", "items" : { "type" : "string", "description" : "The types of the application", "enum" : [ "SPA", "MPA" ] } }, "applicationDescription" : { "type" : "string", "description" : "The description of the application" }, "technologyStack" : { "type" : "string", "description" : "The technology stack the application is built on" }, "focusArea" : { "type" : "string", "description" : "The focus area of the assessment" }, "includeExecutiveSummary" : { "type" : "boolean", "description" : "Indicates if an executive summary should be included in the assessment report" }, "technicalContactName" : { "type" : "string", "description" : "The name of the technical contact for the application" }, "technicalContactEmail" : { "maxLength" : 150, "minLength" : 3, "type" : "string", "description" : "The email to the technical contact for the application" }, "preferredStartDate" : { "type" : "string", "description" : "The preferred start date of the assessment", "format" : "date-time" }, "commentPendingSince" : { "type" : "string", "description" : "The date since comment is pending", "format" : "date-time", "readOnly" : true }, "commentsCount" : { "type" : "integer", "description" : "The number of comments", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "description" : "The customer name" }, "assetGroup" : { "$ref" : "#/components/schemas/EngagementRequest.AssetGroup" }, "accounts" : { "type" : "array", "description" : "Information of all accounts the engagement request is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/EngagementRequest.Account" } } } }, "EngagementRequest.Account" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "role" : { "type" : "string" } }, "description" : "Information of all accounts the engagement request is linked to", "readOnly" : true }, "EngagementRequest.AssetGroup" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" } }, "description" : "The associated asset group", "readOnly" : true }, "DatabaseSetting" : { "required" : [ "host" ], "type" : "object", "properties" : { "host" : { "minLength" : 1, "type" : "string" }, "port" : { "maximum" : 65535, "minimum" : 1, "type" : "integer", "format" : "int32" }, "password" : { "type" : "string" }, "ssl" : { "type" : "boolean" }, "certificate" : { "type" : "string" } } }, "BaseContentConfiguration" : { "required" : [ "integrationType" ], "type" : "object", "properties" : { "integrationType" : { "type" : "string", "enum" : [ "WEBHOOK", "EMAIL", "LOG", "SYSLOG", "SNMP", "NOTIFICATION" ] } } }, "EmailContentConfiguration" : { "required" : [ "integrationType", "subject" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "subject" : { "minLength" : 1, "type" : "string" }, "userList" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "userEmailAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "content" : { "type" : "string" }, "htmlContent" : { "type" : "string" } } } ] }, "EventSubscription" : { "required" : [ "name", "trigger" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "trigger" : { "type" : "string", "enum" : [ "SCHEDULE_CREATED", "SCHEDULE_DELETED", "SCHEDULE_MODIFIED", "SCHEDULE_SCHEDULED", "CONFIGURATION_CREATED", "CONFIGURATION_DELETED", "CONFIGURATION_MODIFIED", "CONFIGURATION_STARTED", "CONFIGURATION_DONE", "SCAN_STARTED", "SCAN_STOPPED", "SCAN_DONE", "ASSET_NOT_RECENTLY_SEEN", "ASSET_SEEN", "ASSET_CREATED", "ASSET_DELETED", "ASSET_MODIFIED", "FINDING_SEEN", "FINDING_CREATED", "FINDING_MODIFIED", "FINDING_STATUS_TRANSITIONED", "FINDING_RISK_ACCEPTED_EXPIRATION", "WATCHED_FINDING_UPDATED", "USER_CREATED", "USER_DELETED", "USER_MODIFIED", "USER_LOGIN_ATTEMPT", "USER_PASSWORD_RESET", "ROLE_CREATED", "ROLE_DELETED", "ROLE_MODIFIED", "RESOURCE_GROUP_CREATED", "RESOURCE_GROUP_DELETED", "RESOURCE_GROUP_MODIFIED", "RELEASE_NOTES_PUBLISHED", "HIAB_SCANNER_MISSING", "HIAB_UPDATE_DONE", "HIAB_UPDATE_FAILED", "HIAB_BACKUP_DONE", "HIAB_BACKUP_FAILED", "HIAB_MAINTENANCE_PLAN_DONE", "HIAB_DISK_USAGE_HIGH", "HIAB_REBOOTED", "HIAB_REMOTE_SUPPORT", "OUTSCAN_CONSULTANCY", "CONSUMPTION_ABSOLUTE", "CONSUMPTION_RELATIVE", "WORKFLOW_CREATED", "WORKFLOW_DELETED", "WORKFLOW_MODIFIED", "WORKFLOW_STARTED", "WORKFLOW_DONE", "COMPLIANCE_CREATED", "COMPLIANCE_MODIFIED", "COMPLIANCE_RISK_EXCEPTION", "COMPLIANCE_RISK_EXCEPTION_EXPIRATION", "COMMENT_CREATED", "EXECUTIVE_SUMMARY_UPDATED", "ACTIVITY_FEED_UPDATED", "ASSET_GROUP_CREATED", "ASSET_GROUP_DELETED", "ASSET_GROUP_MODIFIED", "NEWSLETTER_PUBLISHED", "COMMERCIAL_PUBLISHED", "CUSTOMER_COMMUNICATION_PUBLISHED", "INFORMATION_PRODUCT_CREATED", "INFORMATION_PRODUCT_MODIFIED", "INFORMATION_PRODUCT_SEEN", "INFORMATION_PRODUCT_EOL", "INFORMATION_PORT_CREATED", "INFORMATION_PORT_MODIFIED", "INFORMATION_PORT_SEEN", "INFORMATION_SERVICE_CREATED", "INFORMATION_SERVICE_MODIFIED", "INFORMATION_SERVICE_SEEN", "INFORMATION_CERTIFICATE_CREATED", "INFORMATION_CERTIFICATE_MODIFIED", "INFORMATION_CERTIFICATE_SEEN", "ENGAGEMENT_REQUEST_CREATED", "ENGAGEMENT_REQUEST_MODIFIED", "MANAGED_REPORT_UPLOADED", "AUTOMATION_RULE_CREATED", "AUTOMATION_RULE_DELETED", "AUTOMATION_RULE_MODIFIED", "FINDING_SCORE_CHANGE", "CHECK_SCORE_CHANGE", "FINDING_NEW_EXPLOIT", "CHECK_NEW_EXPLOIT", "AGENT_RETIRED", "AGENT_NOT_CALLHOME", "AGENT_NOT_SCAN", "AGENT_OUTDATED" ] }, "viewTemplateId" : { "type" : "integer", "format" : "int32" }, "integrationId" : { "type" : "integer", "format" : "int32" }, "integrationType" : { "type" : "string", "readOnly" : true, "enum" : [ "WEBHOOK", "EMAIL", "LOG", "SYSLOG", "SNMP", "NOTIFICATION" ] }, "enabled" : { "type" : "boolean" }, "settings" : { "$ref" : "#/components/schemas/EventSubscription.Settings" }, "contentConfiguration" : { "$ref" : "#/components/schemas/BaseContentConfiguration" }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "errors" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/EventSubscriptionError" } } } }, "EventSubscription.Settings" : { "type" : "object", "properties" : { "timeBefore" : { "type" : "integer", "format" : "int32" }, "timeSince" : { "type" : "integer", "format" : "int32" }, "diskUsage" : { "type" : "integer", "format" : "int32" }, "metric" : { "type" : "string", "enum" : [ "NETSEC_ASSETS", "NETSEC_SCANS", "NETSEC_INTERNAL_ASSETS", "NETSEC_INTERNAL_SCANS", "NETSEC_APPLIANCE_ASSETS", "NETSEC_APPLIANCE_SCANS", "NETSEC_APPLIANCE_EXTERNAL_ASSETS", "NETSEC_APPLIANCE_EXTERNAL_SCANS", "COMPLIANCE_ASSETS", "COMPLIANCE_SCANS", "COMPLIANCE_INTERNAL_ASSETS", "COMPLIANCE_INTERNAL_SCANS", "COMPLIANCE_APPLIANCE_ASSETS", "COMPLIANCE_APPLIANCE_SCANS", "COMPLIANCE_APPLIANCE_EXTERNAL_ASSETS", "COMPLIANCE_APPLIANCE_EXTERNAL_SCANS", "PCI_ASSETS", "PCI_SCANS", "SCALE_ASSETS", "SCALE_SCANS", "SCALE_INTERNAL_ASSETS", "SCALE_APPLIANCE_ASSETS", "SCALE_APPLIANCE_SCANS", "SCALE_APPLIANCE_EXTERNAL_ASSETS", "SCALE_APPLIANCE_EXTERNAL_SCANS", "CLOUDSEC_ASSETS", "CLOUDSEC_SCANS", "NETWORK_DISCOVERY_SCANS", "NETWORK_DISCOVERY_APPLIANCE_SCANS", "NETWORK_LOOKUPS", "NETWORK_APPLIANCE_LOOKUPS", "CLOUD_DISCOVERY_SCANS", "CLOUD_DISCOVERY_APPLIANCE_SCANS", "NETWORK_ASSETS", "NETWORK_SCANS", "NETWORK_APPLIANCE_ASSETS", "NETWORK_APPLIANCE_SCANS", "DOCKER_IMAGE_DISCOVERY_SCANS", "DOCKER_IMAGE_ASSETS", "DOCKER_IMAGE_SCANS", "DOCKER_IMAGE_DISCOVERY_APPLIANCE_SCANS", "DOCKER_IMAGE_APPLIANCE_ASSETS", "DOCKER_IMAGE_APPLIANCE_SCANS", "OUTSCAN_NX_ASSETS", "OUTSCAN_NX_APPLIANCE_ASSETS" ] }, "limit" : { "type" : "integer", "format" : "int32" }, "userId" : { "type" : "integer", "format" : "int32" }, "from" : { "type" : "string", "enum" : [ "to review", "to verify", "to QA", "to publish", "rejected", "present", "accepted", "false positive", "pending verification", "fixed", "irreproducible" ] }, "to" : { "type" : "string", "enum" : [ "to review", "to verify", "to QA", "to publish", "rejected", "present", "accepted", "false positive", "pending verification", "fixed", "irreproducible" ] }, "entityType" : { "type" : "string", "enum" : [ "FINDING", "ASSET_GROUP", "ASSET", "SCAN_CONFIGURATION", "SCHEDULE", "SCAN", "USER", "USER_ACCOUNT", "ROLE", "RESOURCE_GROUP", "COMPLIANCE", "WORKFLOW", "CHECK", "PRODUCT_INFORMATION", "INFORMATION", "ENGAGEMENT_REQUEST", "MANAGED_REPORT", "SCHEDULED_REPORT", "AUTOMATION_RULE", "CVE", "AGENT" ] }, "cveScoreType" : { "type" : "string", "enum" : [ "FARSIGHT", "EPSS" ] }, "cveScoreComparisonType" : { "type" : "string", "enum" : [ "OVER", "BELOW" ] }, "cveScoreThreshold" : { "type" : "number", "format" : "double" }, "originalTrigger" : { "type" : "string", "enum" : [ "SCHEDULE_CREATED", "SCHEDULE_DELETED", "SCHEDULE_MODIFIED", "SCHEDULE_SCHEDULED", "CONFIGURATION_CREATED", "CONFIGURATION_DELETED", "CONFIGURATION_MODIFIED", "CONFIGURATION_STARTED", "CONFIGURATION_DONE", "SCAN_STARTED", "SCAN_STOPPED", "SCAN_DONE", "ASSET_NOT_RECENTLY_SEEN", "ASSET_SEEN", "ASSET_CREATED", "ASSET_DELETED", "ASSET_MODIFIED", "FINDING_SEEN", "FINDING_CREATED", "FINDING_MODIFIED", "FINDING_STATUS_TRANSITIONED", "FINDING_RISK_ACCEPTED_EXPIRATION", "WATCHED_FINDING_UPDATED", "USER_CREATED", "USER_DELETED", "USER_MODIFIED", "USER_LOGIN_ATTEMPT", "USER_PASSWORD_RESET", "ROLE_CREATED", "ROLE_DELETED", "ROLE_MODIFIED", "RESOURCE_GROUP_CREATED", "RESOURCE_GROUP_DELETED", "RESOURCE_GROUP_MODIFIED", "RELEASE_NOTES_PUBLISHED", "HIAB_SCANNER_MISSING", "HIAB_UPDATE_DONE", "HIAB_UPDATE_FAILED", "HIAB_BACKUP_DONE", "HIAB_BACKUP_FAILED", "HIAB_MAINTENANCE_PLAN_DONE", "HIAB_DISK_USAGE_HIGH", "HIAB_REBOOTED", "HIAB_REMOTE_SUPPORT", "OUTSCAN_CONSULTANCY", "CONSUMPTION_ABSOLUTE", "CONSUMPTION_RELATIVE", "WORKFLOW_CREATED", "WORKFLOW_DELETED", "WORKFLOW_MODIFIED", "WORKFLOW_STARTED", "WORKFLOW_DONE", "COMPLIANCE_CREATED", "COMPLIANCE_MODIFIED", "COMPLIANCE_RISK_EXCEPTION", "COMPLIANCE_RISK_EXCEPTION_EXPIRATION", "COMMENT_CREATED", "EXECUTIVE_SUMMARY_UPDATED", "ACTIVITY_FEED_UPDATED", "ASSET_GROUP_CREATED", "ASSET_GROUP_DELETED", "ASSET_GROUP_MODIFIED", "NEWSLETTER_PUBLISHED", "COMMERCIAL_PUBLISHED", "CUSTOMER_COMMUNICATION_PUBLISHED", "INFORMATION_PRODUCT_CREATED", "INFORMATION_PRODUCT_MODIFIED", "INFORMATION_PRODUCT_SEEN", "INFORMATION_PRODUCT_EOL", "INFORMATION_PORT_CREATED", "INFORMATION_PORT_MODIFIED", "INFORMATION_PORT_SEEN", "INFORMATION_SERVICE_CREATED", "INFORMATION_SERVICE_MODIFIED", "INFORMATION_SERVICE_SEEN", "INFORMATION_CERTIFICATE_CREATED", "INFORMATION_CERTIFICATE_MODIFIED", "INFORMATION_CERTIFICATE_SEEN", "ENGAGEMENT_REQUEST_CREATED", "ENGAGEMENT_REQUEST_MODIFIED", "MANAGED_REPORT_UPLOADED", "AUTOMATION_RULE_CREATED", "AUTOMATION_RULE_DELETED", "AUTOMATION_RULE_MODIFIED", "FINDING_SCORE_CHANGE", "CHECK_SCORE_CHANGE", "FINDING_NEW_EXPLOIT", "CHECK_NEW_EXPLOIT", "AGENT_RETIRED", "AGENT_NOT_CALLHOME", "AGENT_NOT_SCAN", "AGENT_OUTDATED" ] } } }, "EventSubscriptionError" : { "required" : [ "details", "message", "timestamp" ], "type" : "object", "properties" : { "timestamp" : { "type" : "string", "format" : "date-time" }, "message" : { "type" : "string" }, "details" : { "type" : "array", "items" : { "type" : "string" } } }, "description" : "EventSubscriptionError", "readOnly" : true }, "LogContentConfiguration" : { "required" : [ "content", "integrationType" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "content" : { "minLength" : 1, "type" : "string" } } } ] }, "NotificationContentConfiguration" : { "required" : [ "integrationType", "subject", "userId" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "userId" : { "type" : "integer", "format" : "int32" }, "subject" : { "minLength" : 1, "type" : "string" }, "message" : { "type" : "string" }, "url" : { "type" : "string" } } } ] }, "SnmpContentConfiguration" : { "required" : [ "integrationType", "objectId" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "objectId" : { "minLength" : 1, "type" : "string" }, "content" : { "type" : "string" }, "maxRetries" : { "maximum" : 10, "minimum" : 0, "type" : "integer", "format" : "int32" }, "retryInterval" : { "maximum" : 60, "minimum" : 1, "type" : "integer", "format" : "int32" } } } ] }, "SyslogContentConfiguration" : { "required" : [ "content", "format", "integrationType" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "format" : { "type" : "string", "enum" : [ "RFC5424", "RFC3164", "LEGACY" ] }, "applicationName" : { "type" : "string" }, "processId" : { "type" : "string" }, "messageId" : { "type" : "string" }, "tag" : { "type" : "string" }, "facility" : { "type" : "integer", "format" : "int32" }, "severity" : { "type" : "integer", "format" : "int32" }, "structuredData" : { "type" : "string" }, "content" : { "minLength" : 1, "type" : "string" }, "maxRetries" : { "maximum" : 10, "minimum" : 0, "type" : "integer", "format" : "int32" }, "retryInterval" : { "maximum" : 60, "minimum" : 1, "type" : "integer", "format" : "int32" } } } ] }, "WebhookContentConfiguration" : { "required" : [ "content", "integrationType" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseContentConfiguration" }, { "type" : "object", "properties" : { "content" : { "minLength" : 1, "type" : "string" }, "maxRetries" : { "maximum" : 10, "minimum" : 0, "type" : "integer", "format" : "int32" }, "retryInterval" : { "maximum" : 60, "minimum" : 1, "type" : "integer", "format" : "int32" }, "httpMethod" : { "type" : "string" }, "httpHeaders" : { "type" : "string" } } } ] }, "EventTemplateVariable" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "The event template variable name" }, "description" : { "type" : "string", "description" : "The event template variable description" } } }, "FindingTemplateGroup" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The name of the finding template group" }, "parentId" : { "type" : "integer", "description" : "The parent finding template group", "format" : "int32" } } }, "FindingTemplate" : { "required" : [ "source", "template" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "uuid" : { "type" : "string" }, "groupId" : { "type" : "integer", "format" : "int32" }, "cvssV2Score" : { "type" : "number", "description" : "The CVSS V2 score", "format" : "float", "readOnly" : true }, "cvssV3Score" : { "type" : "number", "description" : "The CVSS V3 score", "format" : "float", "readOnly" : true }, "cvssV2Severity" : { "type" : "string", "description" : "The CVSS V2 severity", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssV3Severity" : { "type" : "string", "description" : "The CVSS V3 severity", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "source" : { "minItems" : 1, "type" : "array", "description" : "The finding template sources", "items" : { "type" : "string", "description" : "The finding template sources", "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "template" : { "$ref" : "#/components/schemas/FindingTemplate.Template" }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "FindingTemplate.Template" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "description" : { "type" : "string" }, "remediation" : { "type" : "string" }, "impact" : { "type" : "string" }, "recreation" : { "type" : "string" }, "cwe" : { "type" : "integer", "format" : "int32" }, "cvssV2Vector" : { "type" : "string" }, "cvssV3Vector" : { "type" : "string" }, "owaspMobile2024" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "format" : "int32" }, "owaspApi2023" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "format" : "int32" } }, "description" : "The finding template attributes" }, "FindingStatusTransitionRequest" : { "type" : "object", "properties" : { "comment" : { "type" : "string" } } }, "FindingExportAsEmail" : { "required" : [ "emailAddresses" ], "type" : "object", "properties" : { "emailAddresses" : { "maxItems" : 20, "minItems" : 1, "type" : "array", "items" : { "type" : "string" } }, "comment" : { "maxLength" : 250, "minLength" : 0, "type" : "string" } } }, "Attachment" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "findingId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "type" : { "type" : "string", "readOnly" : true, "enum" : [ "OTHER", "IMAGE", "TEXT", "VIDEO", "ARCHIVE" ] }, "name" : { "type" : "string", "readOnly" : true } } }, "AppCheckMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "checkId" : { "type" : "integer", "format" : "int32" }, "vulnerabilityId" : { "type" : "string" }, "gatheredInformation" : { "type" : "string" } } } ] }, "BaseMatch" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "WAS", "GATHEREDINFORMATION", "COMPONENT", "COMPLIANCE", "PAC", "PRODUCT", "PORT", "SERVICE", "CERTIFICATE" ] }, "service" : { "$ref" : "#/components/schemas/Service" }, "patternUuid" : { "type" : "string" } }, "description" : "The match list", "readOnly" : true }, "CertificateMatch" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "chainId" : { "type" : "string", "description" : "Certificate chain id" }, "certificates" : { "type" : "array", "description" : "Certificate list", "items" : { "$ref" : "#/components/schemas/CertificateMatch.Certificate" } } } } ] }, "CertificateMatch.Certificate" : { "type" : "object", "properties" : { "subject" : { "type" : "string" }, "issuer" : { "type" : "string" }, "signatureAlgorithm" : { "type" : "string" }, "serialNumber" : { "type" : "string" }, "sniName" : { "type" : "string" }, "keyAlgorithm" : { "type" : "string" }, "keyBits" : { "type" : "integer", "format" : "int32" }, "notValidBefore" : { "type" : "string", "format" : "date-time" }, "notValidAfter" : { "type" : "string", "format" : "date-time" }, "pem" : { "type" : "string" } }, "description" : "Certificate list" }, "ComplianceMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "requirementId" : { "type" : "integer", "format" : "int32" }, "compliant" : { "type" : "boolean" }, "message" : { "type" : "string" }, "error" : { "type" : "string" }, "humanCheck" : { "type" : "boolean" }, "faultyItems" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "string" } } }, "checkedAssets" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "string" } } } } } ] }, "ComponentMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "name" : { "type" : "string" }, "presentableName" : { "type" : "string" }, "version" : { "type" : "string" } } } ] }, "Finding" : { "required" : [ "assetId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "checkId" : { "type" : "integer", "description" : "The check id associated with the finding", "format" : "int32" }, "findingTemplateId" : { "type" : "integer", "description" : "The finding template from which the finding was created", "format" : "int32" }, "cvssScore" : { "type" : "number", "description" : "The CVSS score, take CVSS V3 if available, otherwise CVSS V2", "format" : "float", "readOnly" : true }, "cvssSeverity" : { "type" : "string", "description" : "The CVSS severity, take CVSS V3 severity if available, otherwise CVSS V2", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssV2Score" : { "type" : "number", "description" : "The CVSS V2 score", "format" : "float", "readOnly" : true }, "cvssV2BaseScore" : { "type" : "number", "description" : "The CVSS V2 base score", "format" : "float", "readOnly" : true }, "cvssV2TemporalScore" : { "type" : "number", "description" : "The CVSS V2 temporal score", "format" : "float", "readOnly" : true }, "cvssV2EnvironmentalScore" : { "type" : "number", "description" : "The CVSS V2 environmental score", "format" : "float", "readOnly" : true }, "cvssV2Vector" : { "type" : "string", "description" : "The CVSS V2 vector", "readOnly" : true }, "cvssV2Severity" : { "type" : "string", "description" : "The CVSS V2 severity", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssV3Score" : { "type" : "number", "description" : "The CVSS V3 score", "format" : "float", "readOnly" : true }, "cvssV3BaseScore" : { "type" : "number", "description" : "The CVSS V3 base score", "format" : "float", "readOnly" : true }, "cvssV3TemporalScore" : { "type" : "number", "description" : "The CVSS V3 temporal score", "format" : "float", "readOnly" : true }, "cvssV3EnvironmentalScore" : { "type" : "number", "description" : "The CVSS V3 environmental score", "format" : "float", "readOnly" : true }, "cvssV3Vector" : { "type" : "string", "description" : "The CVSS V3 vector", "readOnly" : true }, "cvssV3Severity" : { "type" : "string", "description" : "The CVSS V3 severity", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "falsePositive" : { "type" : "string", "description" : "The date when marked as false positive", "format" : "date-time", "readOnly" : true }, "falsePositiveComment" : { "type" : "string", "description" : "The false positive comment", "readOnly" : true }, "isAccepted" : { "type" : "boolean", "description" : "Set to true when the risk is accepted", "readOnly" : true }, "accepted" : { "type" : "string", "description" : "The date when risk marked as accepted", "format" : "date-time", "readOnly" : true }, "acceptedComment" : { "type" : "string", "description" : "The accepted comment", "readOnly" : true }, "acceptedUntil" : { "type" : "string", "description" : "The date until risk marked as accepted", "format" : "date-time", "readOnly" : true }, "fixed" : { "type" : "string", "description" : "The date when the risk was fixed", "format" : "date-time", "readOnly" : true }, "statusVerified" : { "type" : "boolean", "description" : "Set to true if a finding is verified by a GL consultant", "readOnly" : true }, "commentsCount" : { "type" : "integer", "description" : "The number of comments", "format" : "int32", "readOnly" : true }, "customName" : { "type" : "string", "description" : "The custom name" }, "customDescription" : { "type" : "string", "description" : "The custom description" }, "customCve" : { "type" : "string", "description" : "The custom CVE" }, "customCwe" : { "type" : "integer", "description" : "The custom CWE", "format" : "int32" }, "customBugTraq" : { "type" : "string", "description" : "The custom bug track" }, "customSolution" : { "type" : "string", "description" : "The custom solution" }, "customRecreation" : { "type" : "string", "description" : "The custom recreation" }, "customImpact" : { "type" : "string", "description" : "The custom impact" }, "customOwaspMobile2024" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "Custom OWASP Mobile 2024 score", "format" : "int32" }, "customOwaspApi2023" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "Custom OWASP API 2023 score", "format" : "int32" }, "solutionPatches" : { "type" : "array", "description" : "The solution patches", "items" : { "type" : "string", "description" : "The solution patches" } }, "customCvssV2Vector" : { "type" : "string", "description" : "The custom CVSS V2 vector" }, "customCvssV2Severity" : { "type" : "string", "description" : "The custom CVSS V2 severity", "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "customCvssV3Vector" : { "type" : "string", "description" : "The custom CVSS V3 vector" }, "customCvssV3Severity" : { "type" : "string", "description" : "The custom CVSS V3 severity", "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "source" : { "type" : "array", "description" : "The scan sources", "readOnly" : true, "items" : { "type" : "string", "description" : "The scan sources", "readOnly" : true, "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "activeSubscriptionTypes" : { "type" : "array", "description" : "The finding's active subscription types", "readOnly" : true, "items" : { "type" : "string", "description" : "The finding's active subscription types", "readOnly" : true, "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] } }, "name" : { "type" : "string", "description" : "The finding name", "readOnly" : true }, "description" : { "type" : "string", "description" : "The finding description", "readOnly" : true }, "cve" : { "type" : "string", "description" : "The finding CVE", "readOnly" : true }, "cwe" : { "type" : "string", "description" : "The finding CWE", "readOnly" : true }, "solutionType" : { "type" : "string", "description" : "The solution type", "readOnly" : true, "enum" : [ "NOT_CLASSIFIED", "UNKNOWN", "RECONFIGURE", "WORKAROUND", "SOLUTION_IN_PROGRESS", "CONTACT_VENDOR", "UPDATE", "PATCH", "NOT_ACKNOWLEDGED", "NO_SOLUTION", "CONFIGURE_ACCOUNT", "DISABLE", "FILTER", "MALWARE" ] }, "solution" : { "type" : "string", "description" : "The solution", "readOnly" : true }, "solutionProduct" : { "type" : "string", "description" : "The solution product", "readOnly" : true }, "solutionTitle" : { "type" : "string", "description" : "The solution title", "readOnly" : true }, "solutionUuid" : { "type" : "string", "description" : "The solution uuid", "readOnly" : true }, "exploitAvailable" : { "type" : "boolean", "description" : "Set to true when exploits are available", "readOnly" : true }, "cisaKev" : { "type" : "boolean", "description" : "Set to true when CVE is listed in CISA KEV catalog", "readOnly" : true }, "matchIds" : { "type" : "array", "description" : "The match ids", "items" : { "type" : "integer", "description" : "The match ids", "format" : "int32" } }, "attachmentIds" : { "type" : "array", "description" : "The attachments ids", "readOnly" : true, "items" : { "type" : "integer", "description" : "The attachments ids", "format" : "int32", "readOnly" : true } }, "firstSeen" : { "type" : "string", "description" : "The date when first seen", "format" : "date-time", "readOnly" : true }, "lastSeen" : { "type" : "string", "description" : "The date when last seen", "format" : "date-time", "readOnly" : true }, "firstScanId" : { "type" : "integer", "description" : "The id of the first scan", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "description" : "The id of the last scan", "format" : "int32", "readOnly" : true }, "lastScanConfigurationId" : { "type" : "integer", "description" : "The id of the last scan configuration", "format" : "int32", "readOnly" : true }, "status" : { "type" : "string", "description" : "The finding status", "readOnly" : true, "enum" : [ "to review", "to verify", "to QA", "to publish", "rejected", "present", "accepted", "false positive", "pending verification", "fixed", "irreproducible" ] }, "commentPendingSince" : { "type" : "string", "description" : "The date since comment is pending", "format" : "date-time", "readOnly" : true }, "reviewed" : { "type" : "string", "description" : "The finding reviewed date", "format" : "date-time", "readOnly" : true }, "reviewedBy" : { "type" : "string", "description" : "The username of the user that reviewed the finding", "readOnly" : true }, "reviewedById" : { "type" : "integer", "description" : "The user ID of the user that reviewed the finding", "format" : "int32", "readOnly" : true }, "verified" : { "type" : "string", "description" : "The finding verified date", "format" : "date-time", "readOnly" : true }, "verifiedBy" : { "type" : "string", "description" : "The username of the user that verified the finding", "readOnly" : true }, "verifiedById" : { "type" : "integer", "description" : "The user ID of the user that verified the finding", "format" : "int32", "readOnly" : true }, "qualityAssured" : { "type" : "string", "description" : "The finding quality assured date", "format" : "date-time", "readOnly" : true }, "qualityAssuredBy" : { "type" : "string", "description" : "The username of the user that quality assured the finding", "readOnly" : true }, "qualityAssuredById" : { "type" : "integer", "description" : "The user ID of the user that quality assured the finding", "format" : "int32", "readOnly" : true }, "published" : { "type" : "string", "description" : "The finding published date", "format" : "date-time", "readOnly" : true }, "publishedBy" : { "type" : "string", "description" : "The username of the user that published the finding", "readOnly" : true }, "publishedById" : { "type" : "integer", "description" : "The user ID of the user that published the finding", "format" : "int32", "readOnly" : true }, "rejected" : { "type" : "string", "description" : "The finding rejected date", "format" : "date-time", "readOnly" : true }, "rejectedBy" : { "type" : "string", "description" : "The username of the user that rejected the finding", "readOnly" : true }, "rejectedById" : { "type" : "integer", "description" : "The user ID of the user that rejected the finding", "format" : "int32", "readOnly" : true }, "recreation" : { "type" : "string", "description" : "The recreation", "readOnly" : true }, "alternativeRecreation" : { "type" : "string", "description" : "The alternate recreation" }, "impact" : { "type" : "string", "description" : "The impact" }, "sans25" : { "type" : "integer", "description" : "The SANS 25 score", "format" : "int32", "readOnly" : true }, "owasp2004" : { "type" : "array", "description" : "The OWASP 2004 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2004 scores", "format" : "int32", "readOnly" : true } }, "owasp2007" : { "type" : "array", "description" : "The OWASP 2007 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2007 scores", "format" : "int32", "readOnly" : true } }, "owasp2010" : { "type" : "array", "description" : "The OWASP 2010 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2010 scores", "format" : "int32", "readOnly" : true } }, "owasp2013" : { "type" : "array", "description" : "The OWASP 2013 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2013 scores", "format" : "int32", "readOnly" : true } }, "owasp2017" : { "type" : "array", "description" : "The OWASP 2017 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2017 scores", "format" : "int32", "readOnly" : true } }, "owasp2021" : { "type" : "array", "description" : "The OWASP 2021 scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The OWASP 2021 scores", "format" : "int32", "readOnly" : true } }, "owaspMobile2024" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "The OWASP Mobile 2024 score", "format" : "int32" }, "owaspApi2023" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "The OWASP API 2023 score", "format" : "int32" }, "capec" : { "type" : "array", "description" : "The CAPEC scores", "readOnly" : true, "items" : { "type" : "integer", "description" : "The CAPEC scores", "format" : "int32", "readOnly" : true } }, "assetId" : { "type" : "integer", "description" : "The asset id", "format" : "int32" }, "assetName" : { "type" : "string", "description" : "The asset name", "readOnly" : true }, "potential" : { "type" : "boolean", "description" : "The finding potential. Set to true when potential false positive" }, "softwareComponent" : { "type" : "string", "description" : "The software component", "readOnly" : true }, "cyrating" : { "type" : "number", "description" : "The cyrating", "format" : "double", "readOnly" : true }, "cyratingDelta" : { "type" : "number", "description" : "The cyrating delta", "format" : "double", "readOnly" : true }, "exploitProbability" : { "type" : "number", "description" : "The exploit probability", "format" : "double", "readOnly" : true }, "exploitProbabilityDelta" : { "type" : "number", "description" : "The exploit probability delta", "format" : "double", "readOnly" : true }, "epssScore" : { "type" : "number", "description" : "The EPSS score", "format" : "double", "readOnly" : true }, "epssScoreDelta" : { "type" : "number", "description" : "The EPSS score delta", "format" : "double", "readOnly" : true }, "cyratingUpdated" : { "type" : "string", "description" : "The cyrating updated date", "format" : "date-time", "readOnly" : true }, "cyratingLastSeen" : { "type" : "string", "description" : "The cyrating last seen date", "format" : "date-time", "readOnly" : true }, "seenLastScan" : { "type" : "boolean", "description" : "Set to true if finding was seen in last scan", "readOnly" : true }, "watching" : { "type" : "boolean", "description" : "Whether the current user is watching this finding", "readOnly" : true }, "age" : { "type" : "integer", "description" : "The finding's age in days since creation", "format" : "int32", "readOnly" : true }, "assetGroupIds" : { "type" : "array", "description" : "The asset group ids", "readOnly" : true, "items" : { "type" : "integer", "description" : "The asset group ids", "format" : "int32", "readOnly" : true } }, "sentTo" : { "type" : "array", "description" : "A list of e-mail addresses that this finding has been sent to", "readOnly" : true, "items" : { "type" : "string", "description" : "A list of e-mail addresses that this finding has been sent to", "readOnly" : true } }, "renderedName" : { "type" : "string", "description" : "Finding name derived from finding template", "readOnly" : true }, "renderedDescription" : { "type" : "string", "description" : "Finding description derived from finding template", "readOnly" : true }, "renderedCwe" : { "type" : "integer", "description" : "Finding CWE derived from finding template", "format" : "int32", "readOnly" : true }, "renderedSolution" : { "type" : "string", "description" : "Solution derived from finding template", "readOnly" : true }, "renderedRecreation" : { "type" : "string", "description" : "Finding recreation derived from finding template", "readOnly" : true }, "renderedImpact" : { "type" : "string", "description" : "Finding impact derived from finding template", "readOnly" : true }, "renderedOwaspMobile2024" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "Finding OWASP Mobile 2024 score derived from finding template", "format" : "int32" }, "renderedOwaspApi2023" : { "maximum" : 10, "minimum" : 1, "type" : "integer", "description" : "Finding OWASP API 2023 score derived from finding template", "format" : "int32" }, "customerName" : { "type" : "string", "description" : "The customer name" }, "enabled" : { "type" : "boolean", "description" : "Set to true if the asset that the finding belongs to is enabled", "readOnly" : true }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "bugTraq" : { "type" : "array", "description" : "The BugTraq", "readOnly" : true, "items" : { "type" : "integer", "description" : "The BugTraq", "format" : "int32", "readOnly" : true } }, "secureCodeWarrior" : { "$ref" : "#/components/schemas/SecureCodeWarrior" }, "farsight" : { "$ref" : "#/components/schemas/Farsight" }, "matches" : { "type" : "array", "description" : "The match list", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/BaseMatch" } }, "classifications" : { "$ref" : "#/components/schemas/Classification.Classifications" }, "ports" : { "type" : "array", "description" : "Ports information on the vulnerability description", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Port" } }, "assetGroups" : { "type" : "array", "description" : "Information of all asset groups the finding is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AssetGroupInformation" } } } }, "GatheredInformationMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "checkId" : { "type" : "integer", "format" : "int32" }, "gatheredInformation" : { "type" : "string" } } } ] }, "Port" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "port" : { "type" : "integer", "format" : "int32" }, "protocol" : { "type" : "string", "enum" : [ "TCP", "UDP" ] } }, "description" : "Ports information on the vulnerability description", "readOnly" : true }, "PortMatch" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "port" : { "type" : "integer", "description" : "Port number", "format" : "int32" }, "protocol" : { "type" : "string", "description" : "Port protocol", "enum" : [ "TCP", "UDP" ] }, "serviceName" : { "type" : "string", "description" : "Port service name" }, "banner" : { "type" : "string", "description" : "Port banner" }, "layer" : { "type" : "string", "description" : "Port layer" }, "encaps" : { "type" : "boolean", "description" : "Port encapsulated" }, "encryption" : { "type" : "array", "description" : "Port encryption", "items" : { "$ref" : "#/components/schemas/PortMatch.Encryption" } } } } ] }, "PortMatch.Encryption" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "TLS_VERSION", "TLS_CIPHER", "SSH_VERSION", "SSH_CIPHER", "SSH_KEX" ] }, "value" : { "type" : "string" } }, "description" : "Port encryption" }, "ProductMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "product" : { "type" : "string", "description" : "Product identifier" }, "name" : { "type" : "string", "description" : "Product name" }, "version" : { "type" : "string", "description" : "Product version" }, "cpeV22" : { "type" : "string", "description" : "Product cpe v2.2" }, "cpeV23" : { "type" : "string", "description" : "Product cpe v2.3" }, "url" : { "type" : "string", "description" : "Product url" }, "eol" : { "type" : "string", "description" : "Product end of life", "format" : "date-time" }, "patches" : { "type" : "array", "description" : "Product patch list", "items" : { "type" : "string", "description" : "Product patch list" } } } } ] }, "Service" : { "required" : [ "name", "protocol" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "scheme" : { "type" : "string" }, "port" : { "type" : "integer", "format" : "int32" }, "protocol" : { "type" : "string", "enum" : [ "TCP", "UDP" ] }, "virtualHost" : { "type" : "string" } } }, "ServiceMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Service name" }, "serviceType" : { "type" : "string", "description" : "Service type", "enum" : [ "WINDOWS" ] }, "status" : { "type" : "string", "description" : "Service status" }, "configuration" : { "type" : "string", "description" : "Service configuration" } } } ] }, "WasMatch" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseMatch" }, { "type" : "object", "properties" : { "checkId" : { "type" : "integer", "format" : "int32" }, "url" : { "type" : "string" }, "method" : { "type" : "string" }, "body" : { "type" : "string" }, "auxData" : { "type" : "array", "items" : { "type" : "string" } }, "context" : { "type" : "string" }, "contextStart" : { "type" : "integer", "format" : "int32" }, "contextLength" : { "type" : "integer", "format" : "int32" } } } ] }, "FindingDelta" : { "type" : "object", "properties" : { "firstSeen" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "lastSeen" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "unchanged" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "asset" : { "$ref" : "#/components/schemas/Asset" } } }, "FindingSolution" : { "type" : "object", "properties" : { "solutionUuid" : { "type" : "string", "readOnly" : true }, "solutionType" : { "type" : "string", "readOnly" : true, "enum" : [ "NOT_CLASSIFIED", "UNKNOWN", "RECONFIGURE", "WORKAROUND", "SOLUTION_IN_PROGRESS", "CONTACT_VENDOR", "UPDATE", "PATCH", "NOT_ACKNOWLEDGED", "NO_SOLUTION", "CONFIGURE_ACCOUNT", "DISABLE", "FILTER", "MALWARE" ] }, "solution" : { "type" : "string", "readOnly" : true }, "solutionProduct" : { "type" : "string", "readOnly" : true }, "solutionTitle" : { "type" : "string", "readOnly" : true }, "riskCount" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "assetCount" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "severityCount" : { "$ref" : "#/components/schemas/FindingSolution.SeverityCount" } } }, "FindingSolution.SeverityCount" : { "type" : "object", "properties" : { "critical" : { "type" : "integer", "format" : "int32" }, "high" : { "type" : "integer", "format" : "int32" }, "medium" : { "type" : "integer", "format" : "int32" }, "low" : { "type" : "integer", "format" : "int32" }, "recommendation" : { "type" : "integer", "format" : "int32" } }, "readOnly" : true }, "FindingFalsePositive" : { "required" : [ "falsePositiveComment" ], "type" : "object", "properties" : { "comment" : { "type" : "string" }, "sendInfo" : { "type" : "boolean" }, "clarificationRequestComment" : { "type" : "string" }, "sendBlueprint" : { "type" : "boolean" }, "falsePositiveComment" : { "minLength" : 1, "type" : "string" } } }, "FindingClarificationRequest" : { "type" : "object", "properties" : { "clarificationRequestComment" : { "type" : "string" } } }, "FindingVerificationRequest" : { "required" : [ "verificationRequestComment" ], "type" : "object", "properties" : { "comment" : { "type" : "string" }, "verificationRequestComment" : { "minLength" : 1, "type" : "string" } } }, "FindingAccept" : { "required" : [ "acceptedComment", "acceptedUntil" ], "type" : "object", "properties" : { "comment" : { "type" : "string" }, "acceptedUntil" : { "type" : "string", "format" : "date-time" }, "acceptedComment" : { "minLength" : 1, "type" : "string" } } }, "Globals" : { "type" : "object", "properties" : { "awsAccountId" : { "type" : "string", "readOnly" : true }, "appliance" : { "type" : "boolean", "readOnly" : true }, "applianceScanner" : { "type" : "boolean", "readOnly" : true }, "awsAccessKeyAllowRemote" : { "type" : "boolean", "readOnly" : true } } }, "Timezone" : { "required" : [ "gmtOffset", "name" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "gmtOffset" : { "type" : "number", "format" : "double" } } }, "Information" : { "required" : [ "assetId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "type" : { "type" : "string", "description" : "The information type", "readOnly" : true, "enum" : [ "PRODUCT", "PORT", "SERVICE", "CERTIFICATE" ] }, "falsePositive" : { "type" : "string", "description" : "The date when marked as false positive", "format" : "date-time", "readOnly" : true }, "falsePositiveComment" : { "type" : "string", "description" : "The false positive comment", "readOnly" : true }, "commentsCount" : { "type" : "integer", "description" : "The number of comments", "format" : "int32", "readOnly" : true }, "source" : { "type" : "array", "description" : "The scan sources", "readOnly" : true, "items" : { "type" : "string", "description" : "The scan sources", "readOnly" : true, "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "matchIds" : { "type" : "array", "description" : "The match ids", "items" : { "type" : "integer", "description" : "The match ids", "format" : "int32" } }, "firstSeen" : { "type" : "string", "description" : "The date when first seen", "format" : "date-time", "readOnly" : true }, "lastSeen" : { "type" : "string", "description" : "The date when last seen", "format" : "date-time", "readOnly" : true }, "firstScanId" : { "type" : "integer", "description" : "The id of the first scan", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "description" : "The id of the last scan", "format" : "int32", "readOnly" : true }, "status" : { "type" : "string", "description" : "The information status", "readOnly" : true, "enum" : [ "present", "false positive" ] }, "assetId" : { "type" : "integer", "description" : "The asset id", "format" : "int32" }, "assetName" : { "type" : "string", "description" : "The asset name", "readOnly" : true }, "seenLastScan" : { "type" : "boolean", "description" : "Set to true if information was seen in last scan", "readOnly" : true }, "age" : { "type" : "integer", "description" : "The information age in days since creation", "format" : "int32", "readOnly" : true }, "assetGroupIds" : { "type" : "array", "description" : "The asset group ids", "items" : { "type" : "integer", "description" : "The asset group ids", "format" : "int32" } }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "matches" : { "type" : "array", "description" : "The matches", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/BaseMatch" } }, "ports" : { "type" : "array", "description" : "The ports information", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Port" } }, "assetGroups" : { "type" : "array", "description" : "Information of all asset groups the information is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AssetGroupInformation" } } } }, "InformationFalsePositive" : { "required" : [ "falsePositiveComment" ], "type" : "object", "properties" : { "falsePositiveComment" : { "minLength" : 1, "type" : "string" } } }, "AgentIntegrationConfiguration" : { "required" : [ "agentServerUrl", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "agentServerUrl" : { "minLength" : 1, "type" : "string" } } } ] }, "BaseAuthenticationConfiguration" : { "required" : [ "authenticationType" ], "type" : "object", "properties" : { "authenticationType" : { "type" : "string", "enum" : [ "BASIC_AUTHENTICATION", "OAUTH2_AUTHENTICATION" ] } } }, "BaseIntegrationConfiguration" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "OBJECT_STORAGE", "AGENT", "ENCRYPTION_SERVICE", "EMAIL", "WEBHOOK", "LOG", "SYSLOG", "SNMP", "CYBERARK", "DELINEA", "NOTIFICATION" ] } } }, "BasicAuthenticationConfiguration" : { "required" : [ "authenticationType", "password", "username" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseAuthenticationConfiguration" }, { "type" : "object", "properties" : { "username" : { "minLength" : 1, "type" : "string" }, "password" : { "minLength" : 1, "type" : "string" } } } ] }, "CyberArkIntegrationConfiguration" : { "required" : [ "applicationId", "type", "url" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "url" : { "minLength" : 1, "pattern" : "^https?://.*", "type" : "string" }, "applicationId" : { "minLength" : 1, "type" : "string" }, "certificate" : { "type" : "string" }, "defaultFolder" : { "type" : "string" }, "defaultSafe" : { "type" : "string" } } } ] }, "DelineaIntegrationConfiguration" : { "required" : [ "password", "type", "url", "username" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "url" : { "minLength" : 1, "pattern" : "^https?://.*", "type" : "string" }, "username" : { "minLength" : 1, "type" : "string" }, "password" : { "minLength" : 1, "type" : "string" }, "certificate" : { "type" : "string" } } } ] }, "EncryptionServiceIntegrationConfiguration" : { "required" : [ "encryptionServiceUrl", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "encryptionServiceUrl" : { "minLength" : 1, "type" : "string" } } } ] }, "Integration" : { "required" : [ "configuration", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "type" : { "type" : "string", "readOnly" : true, "enum" : [ "OBJECT_STORAGE", "AGENT", "ENCRYPTION_SERVICE", "EMAIL", "WEBHOOK", "LOG", "SYSLOG", "SNMP", "CYBERARK", "DELINEA", "NOTIFICATION" ] }, "verified" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "verifiedBy" : { "type" : "string", "readOnly" : true }, "verifiedById" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "verifyStatus" : { "type" : "boolean", "readOnly" : true }, "configuration" : { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "OauthV2AuthenticationConfiguration" : { "required" : [ "authenticationType", "requiredOauthSetting" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseAuthenticationConfiguration" }, { "type" : "object", "properties" : { "requiredOauthSetting" : { "$ref" : "#/components/schemas/OauthV2AuthenticationConfiguration.RequiredOauthSetting" }, "optionalOauthSetting" : { "$ref" : "#/components/schemas/OauthV2AuthenticationConfiguration.OptionalOauthSetting" }, "accessToken" : { "type" : "string" }, "accessTokenCreated" : { "type" : "string", "format" : "date-time" }, "accessTokenExpiresIn" : { "type" : "string", "format" : "date-time" }, "refreshToken" : { "type" : "string" }, "authorized" : { "type" : "boolean" }, "errorMessage" : { "type" : "string" } } } ] }, "OauthV2AuthenticationConfiguration.OptionalOauthSetting" : { "type" : "object", "properties" : { "audience" : { "type" : "string" }, "scope" : { "type" : "array", "items" : { "type" : "string" } } } }, "OauthV2AuthenticationConfiguration.RequiredOauthSetting" : { "required" : [ "authorizeUrl", "clientId", "clientSecret", "oauthApiType", "tokenUrl" ], "type" : "object", "properties" : { "oauthApiType" : { "minLength" : 1, "type" : "string", "enum" : [ "JSON", "FORM_URL_ENCODED" ] }, "authorizeUrl" : { "minLength" : 1, "pattern" : "^https://.*", "type" : "string" }, "tokenUrl" : { "minLength" : 1, "pattern" : "^https://.*", "type" : "string" }, "clientId" : { "minLength" : 1, "type" : "string" }, "clientSecret" : { "minLength" : 1, "type" : "string" } } }, "ObjectStorageIntegrationConfiguration" : { "required" : [ "s3AccessKey", "s3SecretKey", "s3Uri", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "s3Uri" : { "minLength" : 1, "type" : "string" }, "s3AccessKey" : { "minLength" : 1, "type" : "string" }, "s3SecretKey" : { "minLength" : 1, "type" : "string" }, "s3Certificate" : { "type" : "string" } } } ] }, "SnmpIntegrationConfiguration" : { "required" : [ "host", "port", "type", "version" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "host" : { "minLength" : 1, "type" : "string" }, "port" : { "minimum" : 1, "type" : "integer", "format" : "int32" }, "version" : { "maximum" : 3, "minimum" : 2, "type" : "integer", "format" : "int32" }, "community" : { "type" : "string" }, "username" : { "type" : "string" }, "authPassword" : { "type" : "string" }, "privPassword" : { "type" : "string" }, "engineId" : { "type" : "string" }, "prefix" : { "type" : "string" } } } ] }, "SyslogIntegrationConfiguration" : { "required" : [ "host", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "host" : { "minLength" : 1, "type" : "string" }, "format" : { "type" : "string", "enum" : [ "RFC5424", "RFC3164", "LEGACY" ] }, "facility" : { "type" : "integer", "format" : "int32" }, "severity" : { "type" : "integer", "format" : "int32" }, "port" : { "type" : "integer", "format" : "int32" }, "transportType" : { "type" : "string", "enum" : [ "TCP", "UDP" ] }, "prefix" : { "type" : "string" }, "certificate" : { "type" : "string" }, "audit" : { "type" : "boolean" }, "tls" : { "type" : "boolean" }, "arcsight" : { "type" : "boolean" } } } ] }, "WebhookIntegrationConfiguration" : { "required" : [ "webhookUrl" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseIntegrationConfiguration" }, { "type" : "object", "properties" : { "webhookUrl" : { "minLength" : 1, "pattern" : "^https://.*", "type" : "string" }, "contentSample" : { "type" : "string" }, "serverCertificate" : { "type" : "string" }, "httpMethod" : { "type" : "string" }, "httpHeaders" : { "type" : "string" }, "authenticationConfiguration" : { "$ref" : "#/components/schemas/BaseAuthenticationConfiguration" } } } ] }, "ManagedReportGroup" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int64" }, "updated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "count" : { "type" : "integer", "format" : "int64", "readOnly" : true } } }, "ManagedReport" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "Managed report name" }, "size" : { "type" : "integer", "description" : "Report size", "format" : "int32", "readOnly" : true }, "lastDownloaded" : { "type" : "string", "description" : "Time report was last downloaded", "format" : "date-time", "readOnly" : true }, "lastDownloadedBy" : { "type" : "string", "description" : "User that last downloaded report", "readOnly" : true }, "uuid" : { "type" : "string", "description" : "The managed report UUID", "readOnly" : true }, "managed" : { "type" : "boolean", "description" : "Managed internally by (e.g SWAT API or GhostLab)", "readOnly" : true }, "tags" : { "type" : "array", "description" : "The managed report tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Match" : { "required" : [ "assetId", "firstSeen", "lastSeen", "source", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "assetId" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "WAS", "GATHEREDINFORMATION", "COMPONENT", "COMPLIANCE", "PAC", "PRODUCT", "PORT", "SERVICE", "CERTIFICATE" ] }, "firstSeen" : { "type" : "string", "format" : "date-time" }, "lastSeen" : { "type" : "string", "format" : "date-time" }, "firstScanId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "lastScanId" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "findingIds" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "informationIds" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "source" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "subscriptionType" : { "type" : "string", "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] }, "match" : { "$ref" : "#/components/schemas/BaseMatch" }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Notification" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "userId" : { "type" : "integer", "format" : "int64" }, "subUserId" : { "type" : "integer", "format" : "int64" }, "eventSubscriptionId" : { "type" : "integer", "format" : "int32" }, "read" : { "type" : "string", "format" : "date-time" }, "content" : { "$ref" : "#/components/schemas/Notification.Content" } } }, "Notification.Content" : { "required" : [ "subject", "trigger" ], "type" : "object", "properties" : { "subject" : { "minLength" : 1, "type" : "string" }, "message" : { "type" : "string" }, "url" : { "type" : "string" }, "trigger" : { "type" : "string", "enum" : [ "SCHEDULE_CREATED", "SCHEDULE_DELETED", "SCHEDULE_MODIFIED", "SCHEDULE_SCHEDULED", "CONFIGURATION_CREATED", "CONFIGURATION_DELETED", "CONFIGURATION_MODIFIED", "CONFIGURATION_STARTED", "CONFIGURATION_DONE", "SCAN_STARTED", "SCAN_STOPPED", "SCAN_DONE", "ASSET_NOT_RECENTLY_SEEN", "ASSET_SEEN", "ASSET_CREATED", "ASSET_DELETED", "ASSET_MODIFIED", "FINDING_SEEN", "FINDING_CREATED", "FINDING_MODIFIED", "FINDING_STATUS_TRANSITIONED", "FINDING_RISK_ACCEPTED_EXPIRATION", "WATCHED_FINDING_UPDATED", "USER_CREATED", "USER_DELETED", "USER_MODIFIED", "USER_LOGIN_ATTEMPT", "USER_PASSWORD_RESET", "ROLE_CREATED", "ROLE_DELETED", "ROLE_MODIFIED", "RESOURCE_GROUP_CREATED", "RESOURCE_GROUP_DELETED", "RESOURCE_GROUP_MODIFIED", "RELEASE_NOTES_PUBLISHED", "HIAB_SCANNER_MISSING", "HIAB_UPDATE_DONE", "HIAB_UPDATE_FAILED", "HIAB_BACKUP_DONE", "HIAB_BACKUP_FAILED", "HIAB_MAINTENANCE_PLAN_DONE", "HIAB_DISK_USAGE_HIGH", "HIAB_REBOOTED", "HIAB_REMOTE_SUPPORT", "OUTSCAN_CONSULTANCY", "CONSUMPTION_ABSOLUTE", "CONSUMPTION_RELATIVE", "WORKFLOW_CREATED", "WORKFLOW_DELETED", "WORKFLOW_MODIFIED", "WORKFLOW_STARTED", "WORKFLOW_DONE", "COMPLIANCE_CREATED", "COMPLIANCE_MODIFIED", "COMPLIANCE_RISK_EXCEPTION", "COMPLIANCE_RISK_EXCEPTION_EXPIRATION", "COMMENT_CREATED", "EXECUTIVE_SUMMARY_UPDATED", "ACTIVITY_FEED_UPDATED", "ASSET_GROUP_CREATED", "ASSET_GROUP_DELETED", "ASSET_GROUP_MODIFIED", "NEWSLETTER_PUBLISHED", "COMMERCIAL_PUBLISHED", "CUSTOMER_COMMUNICATION_PUBLISHED", "INFORMATION_PRODUCT_CREATED", "INFORMATION_PRODUCT_MODIFIED", "INFORMATION_PRODUCT_SEEN", "INFORMATION_PRODUCT_EOL", "INFORMATION_PORT_CREATED", "INFORMATION_PORT_MODIFIED", "INFORMATION_PORT_SEEN", "INFORMATION_SERVICE_CREATED", "INFORMATION_SERVICE_MODIFIED", "INFORMATION_SERVICE_SEEN", "INFORMATION_CERTIFICATE_CREATED", "INFORMATION_CERTIFICATE_MODIFIED", "INFORMATION_CERTIFICATE_SEEN", "ENGAGEMENT_REQUEST_CREATED", "ENGAGEMENT_REQUEST_MODIFIED", "MANAGED_REPORT_UPLOADED", "AUTOMATION_RULE_CREATED", "AUTOMATION_RULE_DELETED", "AUTOMATION_RULE_MODIFIED", "FINDING_SCORE_CHANGE", "CHECK_SCORE_CHANGE", "FINDING_NEW_EXPLOIT", "CHECK_NEW_EXPLOIT", "AGENT_RETIRED", "AGENT_NOT_CALLHOME", "AGENT_NOT_SCAN", "AGENT_OUTDATED" ] }, "entityType" : { "type" : "string", "enum" : [ "FINDING", "ASSET_GROUP", "ASSET", "SCAN_CONFIGURATION", "SCHEDULE", "SCAN", "USER", "USER_ACCOUNT", "ROLE", "RESOURCE_GROUP", "COMPLIANCE", "WORKFLOW", "CHECK", "PRODUCT_INFORMATION", "INFORMATION", "ENGAGEMENT_REQUEST", "MANAGED_REPORT", "SCHEDULED_REPORT", "AUTOMATION_RULE", "CVE", "AGENT" ] }, "entityId" : { "type" : "integer", "format" : "int32" }, "subEntityType" : { "type" : "string", "enum" : [ "COMMENT", "ATTACHMENT", "ACTIVITY" ] }, "subEntityId" : { "type" : "integer", "format" : "int32" } } }, "Organization" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "uuid" : { "type" : "string", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true } } }, "OutscanFinding" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "scanJobId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "scanLogId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "scheduleId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "templateId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "cvssScore" : { "type" : "number", "format" : "double", "readOnly" : true }, "cvssV3Score" : { "type" : "number", "format" : "double", "readOnly" : true }, "cvssV3Severity" : { "type" : "string", "readOnly" : true, "enum" : [ "RECOMMENDATION", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssV3Vector" : { "type" : "string", "readOnly" : true }, "firstSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "lastSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "reportDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "targetId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "target" : { "type" : "string", "readOnly" : true }, "hostname" : { "type" : "string", "readOnly" : true }, "port" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "protocol" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "source" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true, "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } }, "cve" : { "type" : "string", "readOnly" : true }, "vulnId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "isNew" : { "type" : "boolean", "readOnly" : true }, "previouslyDetected" : { "type" : "boolean", "readOnly" : true }, "type" : { "type" : "string", "readOnly" : true }, "isPotentialFalsePositive" : { "type" : "boolean", "readOnly" : true }, "productName" : { "type" : "string", "readOnly" : true }, "productUrl" : { "type" : "string", "readOnly" : true }, "solutionProduct" : { "type" : "string", "readOnly" : true }, "checkCreated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "hasExploits" : { "type" : "boolean", "readOnly" : true }, "solution" : { "type" : "string", "readOnly" : true }, "businessCriticality" : { "type" : "string", "readOnly" : true, "enum" : [ "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "assetBusinessCriticality" : { "type" : "string", "readOnly" : true, "enum" : [ "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "solutionTitle" : { "type" : "string", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "cyrating" : { "type" : "number", "format" : "double", "readOnly" : true }, "cyratingDelta" : { "type" : "number", "format" : "double", "readOnly" : true }, "cyratingUpdated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "cyratingLastSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "exploitProbability" : { "type" : "number", "format" : "double", "readOnly" : true }, "exploitProbabilityDelta" : { "type" : "number", "format" : "double", "readOnly" : true }, "assetExposed" : { "type" : "boolean", "readOnly" : true }, "owasp2017" : { "type" : "array", "readOnly" : true, "items" : { "type" : "integer", "format" : "int32", "readOnly" : true } }, "isAccepted" : { "type" : "boolean", "readOnly" : true }, "patchInformation" : { "type" : "string", "readOnly" : true }, "cvssVector" : { "type" : "string" }, "virtualHost" : { "type" : "string" }, "platform" : { "type" : "string" }, "bugTraq" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "serviceName" : { "type" : "string" }, "riskLevel" : { "type" : "string", "enum" : [ "Initial", "Recommendation", "Low", "Medium", "High", "Critical" ] }, "solutionType" : { "type" : "string", "enum" : [ "Unspecified", "Unknown", "Reconfigure", "Workaround", "InProgress", "Contact", "Update", "Patch", "Unack", "NoSol", "Account", "Disable", "Filter", "Malware" ] }, "age" : { "type" : "integer", "format" : "int32" }, "data" : { "type" : "string" }, "description" : { "type" : "string", "readOnly" : true }, "farsight" : { "$ref" : "#/components/schemas/Farsight" }, "acceptExpires" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "acceptedBy" : { "type" : "string", "readOnly" : true }, "acceptDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "acceptComment" : { "type" : "string", "readOnly" : true } } }, "OutscanScanLog" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "startDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "endDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "target" : { "type" : "string", "readOnly" : true }, "targetId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "schedule" : { "type" : "string", "readOnly" : true }, "scheduleId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "scanJobId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "status" : { "type" : "string", "enum" : [ "Invalid", "Ok", "Forced", "Timeout", "Stopped", "StoppedByUser", "Large", "KilledLarge", "Failed" ] } } }, "OutscanScan" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "target" : { "type" : "string", "readOnly" : true }, "targetId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "scheduleId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "status" : { "type" : "string", "readOnly" : true }, "scanStarted" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "scanJobId" : { "type" : "integer", "format" : "int64", "readOnly" : true } } }, "OutscanSchedule" : { "required" : [ "name", "targetList" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "nextScanDate" : { "type" : "string", "format" : "date-time" }, "template" : { "type" : "integer", "format" : "int64" }, "name" : { "minLength" : 1, "type" : "string" }, "targetList" : { "minLength" : 1, "type" : "string" }, "recurrence" : { "type" : "string", "enum" : [ "Now", "Once", "Weekly", "Monthly", "Bimonthly", "Quarterly", "Fortnightly", "Daily" ] } } }, "OutscanTarget" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "ip" : { "type" : "string", "readOnly" : true }, "hostname" : { "type" : "string", "readOnly" : true }, "businessCriticality" : { "type" : "string", "readOnly" : true, "enum" : [ "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "exposed" : { "type" : "boolean", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "firstSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "lastSeen" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "source" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true, "enum" : [ "SCOUT", "SWAT", "SCALE", "SCALE_API", "SCALE_SPA", "CLOUDSEC", "NETSEC", "SNAPSHOT", "ASSURE", "APPSEC", "OFFSEC" ] } } } }, "PasswordRecoveryRequest" : { "required" : [ "username" ], "type" : "object", "properties" : { "username" : { "minLength" : 1, "type" : "string" } } }, "ProductInformation" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id", "format" : "int32", "readOnly" : true }, "product" : { "type" : "string", "description" : "The product", "readOnly" : true }, "name" : { "type" : "string", "description" : "The name", "readOnly" : true }, "url" : { "type" : "string", "description" : "The url", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "cpeV2_2" : { "type" : "string", "description" : "The cpe v2.2", "readOnly" : true }, "cpeV2_3" : { "type" : "string", "description" : "The cpe v2.3", "readOnly" : true }, "eol" : { "type" : "array", "description" : "The eol dates for versions", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/ProductInformation.Eol" } } } }, "ProductInformation.Eol" : { "type" : "object", "properties" : { "version" : { "type" : "string" }, "date" : { "type" : "string", "format" : "date-time" } }, "description" : "The eol dates for versions", "readOnly" : true }, "ReportSchedule" : { "required" : [ "encryptionKey", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "subUserId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "frequency" : { "type" : "integer", "format" : "int32" }, "nextDate" : { "type" : "string", "format" : "date-time" }, "latestDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "lastDate" : { "type" : "string", "format" : "date-time" }, "dayWeekMonth" : { "type" : "integer", "format" : "int32" }, "name" : { "minLength" : 1, "type" : "string" }, "reportType" : { "type" : "integer", "format" : "int32" }, "format" : { "type" : "integer", "format" : "int32" }, "zip" : { "type" : "boolean" }, "recipient" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "recipientEmail" : { "type" : "string" }, "encryptionKey" : { "minLength" : 1, "type" : "string" }, "managedReportTitle" : { "type" : "string" }, "managedReportGroup" : { "type" : "integer", "format" : "int64" }, "managedReportToken" : { "type" : "string" }, "scanType" : { "type" : "integer", "format" : "int32" }, "recipientType" : { "type" : "integer", "format" : "int32" }, "reportPassword" : { "type" : "string" }, "reportLevel" : { "type" : "integer", "format" : "int32" }, "customSubject" : { "type" : "string" }, "customText" : { "type" : "string" } } }, "ReportCacheEntry" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "key" : { "type" : "string", "readOnly" : true }, "status" : { "type" : "string", "readOnly" : true }, "size" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "token" : { "type" : "string", "readOnly" : true }, "tokenExpires" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true } } }, "Report" : { "required" : [ "format", "name", "type" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "executiveSummary" : { "type" : "boolean" }, "format" : { "type" : "string", "enum" : [ "PDF", "EXCEL", "XML", "SWATDEMO" ] }, "password" : { "type" : "string" }, "zip" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "Technical", "Trend", "GroupVulnerability", "Delta", "Pci", "WasDiscovery", "Discovery", "SolutionTaskReport", "SolutionTargetReport", "GroupTrending", "GroupDelta", "Compliance", "Consumption" ] }, "level" : { "type" : "string", "enum" : [ "Detailed", "Management", "Summary" ] }, "product" : { "type" : "string", "enum" : [ "Normal", "Pci", "Was", "SWAT", "Compliance", "Appsec Scale", "APPSEC", "CLOUDSEC" ] }, "viewTemplateId" : { "type" : "integer", "format" : "int32" }, "assetIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "assetGroupIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "findingIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "assetIdentifierIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "serviceIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "tagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "startDate" : { "type" : "string", "format" : "date-time" }, "endDate" : { "type" : "string", "format" : "date-time" }, "filters" : { "type" : "string" }, "deliveryMethod" : { "$ref" : "#/components/schemas/DeliveryMethod" } } }, "Resource" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The resource type", "enum" : [ "SCANCONFIGURATION", "ACCOUNT", "SCHEDULEDREPORT", "MANAGEDREPORT", "DASHBOARD", "INTEGRATION", "ASSETGROUP", "ASSET", "APPSTAK", "VIEWTEMPLATE", "EVENTSUBSCRIPTION", "SCANPOLICY", "FINDINGTEMPLATE" ] }, "tagIds" : { "type" : "array", "description" : "The resource tag ids", "items" : { "type" : "integer", "description" : "The resource tag ids", "format" : "int32" } } }, "description" : "The resource group resources" }, "ResourceGroup" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The resource group name" }, "system" : { "type" : "boolean", "description" : "Set to true when resource group is system resource group", "readOnly" : true }, "resources" : { "type" : "array", "description" : "The resource group resources", "items" : { "$ref" : "#/components/schemas/Resource" } } } }, "PatternMatch" : { "required" : [ "match" ], "type" : "object", "properties" : { "request" : { "$ref" : "#/components/schemas/PatternMatch.Request" }, "match" : { "$ref" : "#/components/schemas/PatternMatch.Match" } } }, "PatternMatch.Match" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "version" : { "type" : "string" }, "context" : { "type" : "string" }, "patternUuid" : { "type" : "string" } } }, "PatternMatch.Request" : { "type" : "object", "properties" : { "method" : { "type" : "string" }, "url" : { "type" : "string" } } }, "ScanConfigurationGroup" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int32" }, "count" : { "type" : "integer", "format" : "int64", "readOnly" : true } } }, "AgentScanConfigurationTemplate" : { "required" : [ "assetTagIds", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "assetTagIds" : { "minItems" : 1, "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "scanRecurrence" : { "maximum" : 720, "minimum" : 24, "type" : "integer", "format" : "int32" } } } ] }, "ApplicationAssessmentScanConfigurationTemplate.AllowedDomain" : { "required" : [ "allowSubdomains", "domain" ], "type" : "object", "properties" : { "domain" : { "minLength" : 1, "type" : "string" }, "allow-subdomains" : { "type" : "boolean" } } }, "ApplicationAssessmentScanConfigurationTemplate.CountedRequestPattern" : { "type" : "object", "properties" : { "pattern" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.RequestFilter" }, "limit" : { "type" : "integer", "format" : "int32" } } }, "ApplicationAssessmentScanConfigurationTemplate.HostMap" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "from" : { "minLength" : 1, "type" : "string" }, "to" : { "minItems" : 1, "type" : "array", "items" : { "type" : "string" } } } }, "ApplicationAssessmentScanConfigurationTemplate.RequestFilter" : { "type" : "object", "properties" : { "method" : { "type" : "string" }, "url" : { "type" : "string" }, "body" : { "type" : "string" }, "body-type" : { "type" : "string" } } }, "BaseCloudConfigurationTemplate" : { "type" : "object", "properties" : { "cloudDiscoveryType" : { "type" : "string", "enum" : [ "AWS", "AZURE" ] } } }, "BaseScanConfigurationTemplate" : { "required" : [ "template" ], "type" : "object", "properties" : { "template" : { "type" : "string", "enum" : [ "SCOUT", "SCALE", "SWAT", "CLOUDSEC", "NETWORK_SCAN", "DOCKER_SCAN", "DOCKER_DISCOVERY", "NETWORK_DISCOVERY", "CLOUD_DISCOVERY", "AGENT_SCAN", "WORKFLOW", "NETWORK_LOOKUP" ] } }, "description" : "The scan configuration" }, "CloudDiscoveryAwsConfigurationTemplate" : { "required" : [ "regions" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseCloudConfigurationTemplate" }, { "type" : "object", "properties" : { "regions" : { "minLength" : 1, "type" : "string" } } } ] }, "CloudDiscoveryAzureConfigurationTemplate" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseCloudConfigurationTemplate" }, { "type" : "object", "properties" : { "subscriptions" : { "type" : "string" } } } ] }, "CloudDiscoveryConfigurationTemplate" : { "required" : [ "accountId", "timeout" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "timeout" : { "maximum" : 86400, "minimum" : 600, "type" : "integer", "format" : "int32" }, "accountId" : { "type" : "integer", "format" : "int32" }, "updateAssets" : { "type" : "boolean" }, "importExternalTags" : { "type" : "boolean" }, "externalTagKeys" : { "type" : "array", "items" : { "type" : "string" } }, "addTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "replaceTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "cloudConfiguration" : { "$ref" : "#/components/schemas/BaseCloudConfigurationTemplate" } } } ] }, "CloudsecScanConfigurationTemplate" : { "required" : [ "accountId", "maxConcurrentScans", "policyId", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "accountId" : { "type" : "integer", "format" : "int32" }, "policyId" : { "type" : "integer", "format" : "int32" }, "regions" : { "type" : "string" }, "maxConcurrentScans" : { "minimum" : 0, "type" : "integer", "format" : "int32" } } } ] }, "DockerDiscoveryScanConfigurationTemplate" : { "required" : [ "accountId", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "accountId" : { "type" : "integer", "format" : "int32" } } } ] }, "DockerScanConfigurationTemplate" : { "required" : [ "maxConcurrentScans", "maxConcurrentScansPerAsset", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "maxConcurrentScans" : { "minimum" : 0, "type" : "integer", "format" : "int32" }, "maxConcurrentScansPerAsset" : { "minimum" : 0, "type" : "integer", "format" : "int32" } } } ] }, "NetworkDiscoveryConfigurationTemplate" : { "required" : [ "protocols", "targetList", "template", "timeout" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "timeout" : { "maximum" : 86400, "minimum" : 600, "type" : "integer", "format" : "int32" }, "targetList" : { "minLength" : 1, "type" : "string" }, "ignoreTargetList" : { "type" : "string" }, "protocols" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TCP", "UDP", "ARP", "ICMP" ] } }, "tcpPorts" : { "type" : "string" }, "reportFilters" : { "type" : "string" }, "updateAssets" : { "type" : "boolean" }, "addTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "replaceTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } } ] }, "NetworkScanConfigurationTemplate" : { "required" : [ "maxConcurrentScans", "maxConcurrentScansPerAsset", "scanPolicyId", "template", "timeout" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "scanPolicyId" : { "type" : "integer", "format" : "int32" }, "overrideScanPolicyId" : { "type" : "integer", "format" : "int32" }, "assetTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "timeout" : { "maximum" : 86400, "minimum" : 7200, "type" : "integer", "format" : "int32" }, "scanless" : { "type" : "boolean" }, "anyScanner" : { "type" : "boolean" }, "scanAll" : { "type" : "boolean" }, "allowCloudAssetWithoutCloudResolver" : { "type" : "boolean" }, "maxConcurrentScans" : { "minimum" : 0, "type" : "integer", "format" : "int32" }, "maxConcurrentScansPerAsset" : { "minimum" : 0, "type" : "integer", "format" : "int32" } } } ] }, "ScaleScanConfigurationTemplate" : { "required" : [ "nseconds", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "seeds" : { "type" : "array", "items" : { "type" : "string" } }, "nseconds" : { "maximum" : 86400, "minimum" : 1800, "type" : "integer", "format" : "int32" }, "hostMap" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.HostMap" } }, "fuzzing" : { "type" : "boolean" }, "sequential" : { "type" : "boolean" }, "clientCertificateAuth" : { "$ref" : "#/components/schemas/ScaleScanConfigurationTemplate.ClientCertificate" }, "abortPattern" : { "type" : "string" }, "mustMatch" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.RequestFilter" } }, "cannotMatch" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.RequestFilter" } }, "htmlCannotMatch" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScaleScanConfigurationTemplate.HtmlScopeFilter" } }, "allowedDomains" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.AllowedDomain" } }, "addrBlacklist" : { "type" : "array", "items" : { "type" : "string" } }, "setupProc" : { "type" : "string" }, "setupProcVariables" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "basicAuth" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScaleScanConfigurationTemplate.BasicAuthCredentials" } }, "userAgent" : { "type" : "string" }, "maxIvs" : { "type" : "integer", "format" : "int32" }, "sideScript" : { "type" : "string" }, "playwrightScript" : { "type" : "string" }, "infrastructureScan" : { "type" : "boolean" }, "spaCrawling" : { "type" : "boolean" }, "n-matches" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.CountedRequestPattern" } } } } ] }, "ScaleScanConfigurationTemplate.BasicAuthCredentials" : { "required" : [ "password", "urlPrefix", "user" ], "type" : "object", "properties" : { "user" : { "minLength" : 1, "type" : "string" }, "password" : { "minLength" : 1, "type" : "string" }, "url-prefix" : { "minLength" : 1, "pattern" : "^https?://.*/.*$", "type" : "string" } } }, "ScaleScanConfigurationTemplate.ClientCertificate" : { "required" : [ "clientCertificate", "privateKey" ], "type" : "object", "properties" : { "client-certificate" : { "minLength" : 1, "type" : "string" }, "private-key" : { "minLength" : 1, "type" : "string" }, "passphrase" : { "type" : "string" } } }, "ScaleScanConfigurationTemplate.HtmlScopeFilter" : { "required" : [ "selector" ], "type" : "object", "properties" : { "selector" : { "minLength" : 1, "type" : "string" } } }, "ScanConfiguration" : { "required" : [ "configuration", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The scan name" }, "template" : { "type" : "string", "description" : "The scan template", "readOnly" : true, "enum" : [ "SCOUT", "SCALE", "SWAT", "CLOUDSEC", "NETWORK_SCAN", "DOCKER_SCAN", "DOCKER_DISCOVERY", "NETWORK_DISCOVERY", "CLOUD_DISCOVERY", "AGENT_SCAN", "WORKFLOW", "NETWORK_LOOKUP" ] }, "groupId" : { "type" : "integer", "description" : "The scan group id", "format" : "int32" }, "scheduleIds" : { "type" : "array", "description" : "The schedule ids associated with this scan configuration", "readOnly" : true, "items" : { "type" : "integer", "description" : "The schedule ids associated with this scan configuration", "format" : "int32", "readOnly" : true } }, "assetIdentifierIds" : { "type" : "array", "description" : "The asset links", "items" : { "type" : "integer", "description" : "The asset links", "format" : "int32" } }, "assetIds" : { "type" : "array", "description" : "The asset IDs associated with this scan configuration", "items" : { "type" : "integer", "description" : "The asset IDs associated with this scan configuration", "format" : "int32" } }, "workflowId" : { "type" : "integer", "description" : "The workflow ID associated with this scan configuration", "format" : "int32" }, "scannerTagId" : { "type" : "integer", "description" : "The scanner tag ID associated with this scan configuration", "format" : "int32" }, "enabled" : { "type" : "boolean", "description" : "The scan status. Set to true when enabled" }, "active" : { "type" : "boolean", "description" : "Whether the scan is active" }, "scannerId" : { "type" : "integer", "description" : "The scanner id", "format" : "int32" }, "scannerName" : { "type" : "string", "description" : "The scanner name", "readOnly" : true }, "nextOccurrence" : { "type" : "string", "description" : "The scan next occurrence date", "format" : "date-time", "readOnly" : true }, "lastScan" : { "type" : "string", "description" : "Last time a scan was performed using this configuration", "format" : "date-time", "readOnly" : true }, "configuration" : { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "assetGroups" : { "type" : "array", "description" : "Information of all asset groups the finding is linked to", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AssetGroupInformation" } } } }, "SwatScanConfigurationTemplate" : { "required" : [ "nseconds", "template" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/BaseScanConfigurationTemplate" }, { "type" : "object", "properties" : { "seeds" : { "type" : "array", "items" : { "type" : "string" } }, "nseconds" : { "maximum" : 86400, "minimum" : 1800, "type" : "integer", "format" : "int32" }, "hostMap" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.HostMap" } }, "crawlScope" : { "$ref" : "#/components/schemas/SwatScanConfigurationTemplate.Scope" }, "httpScope" : { "$ref" : "#/components/schemas/SwatScanConfigurationTemplate.Scope" }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SwatScanConfigurationTemplate.Task" } } } } ] }, "SwatScanConfigurationTemplate.Scope" : { "type" : "object", "properties" : { "must-match" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.RequestFilter" } }, "cannot-match" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.RequestFilter" } }, "allowed-domains" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.AllowedDomain" } }, "n-matches" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.CountedRequestPattern" } } } }, "SwatScanConfigurationTemplate.Task" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "enum" : [ "crawl", "patterns", "passive-plugins", "test-inputs", "test-inputs-xss", "response-times", "screenshot", "rule-engine" ] }, "enabled" : { "type" : "boolean" }, "recurrence" : { "type" : "integer", "format" : "int32" } } }, "TestSetupScript" : { "type" : "object", "properties" : { "script" : { "type" : "string" }, "blacklist" : { "type" : "array", "items" : { "type" : "string" } }, "hostmap" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationAssessmentScanConfigurationTemplate.HostMap" } } } }, "ScanPolicySettings" : { "type" : "object", "properties" : { "safeOnly" : { "type" : "boolean" }, "tryDefaultCredentials" : { "type" : "boolean" }, "ignoreFallbackKernels" : { "type" : "boolean" }, "useDiscoveredCredentials" : { "type" : "boolean" }, "virtualHostsIp" : { "type" : "boolean" }, "virtualHostsHostName" : { "type" : "boolean" }, "virtualHostsReverseDns" : { "type" : "boolean" }, "speed" : { "type" : "string" }, "portsTcp" : { "type" : "string" }, "portsUdp" : { "type" : "string" }, "netstatCheck" : { "type" : "string" }, "regularPortScanFallback" : { "type" : "boolean" }, "authenticatedScanSshPort" : { "maximum" : 65535, "minimum" : 0, "type" : "integer", "format" : "int32" }, "trustedCasPem" : { "type" : "string" }, "useCustomCredentials" : { "type" : "boolean" }, "enableRemoteRegistry" : { "type" : "boolean" }, "smbAllowPowershellExecution" : { "type" : "boolean" }, "winrmPort" : { "maximum" : 65535, "minimum" : 0, "type" : "integer", "format" : "int32" } } }, "ScanPolicy" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "system" : { "type" : "boolean", "readOnly" : true }, "accountIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "settings" : { "$ref" : "#/components/schemas/ScanPolicySettings" }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "Scanner" : { "required" : [ "ipaddress", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "ipaddress" : { "minLength" : 1, "type" : "string" }, "mode" : { "type" : "integer", "format" : "int32" }, "approved" : { "type" : "boolean" }, "inactive" : { "type" : "boolean" }, "useProxy" : { "type" : "boolean" }, "polling" : { "type" : "boolean", "readOnly" : true }, "serverStatus" : { "type" : "string", "readOnly" : true }, "lastConnection" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "lastUpdate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "version" : { "type" : "string", "readOnly" : true }, "uiVersion" : { "type" : "string", "readOnly" : true }, "scannerVersion" : { "type" : "string", "readOnly" : true }, "appsecScaleScanner" : { "type" : "boolean", "readOnly" : true }, "groupId" : { "type" : "integer", "format" : "int64" }, "groupName" : { "type" : "string" }, "isOutpost" : { "type" : "boolean", "readOnly" : true }, "isAwsScanner" : { "type" : "boolean", "readOnly" : true }, "scanningDisabled" : { "type" : "boolean", "readOnly" : true }, "isGroup" : { "type" : "boolean" }, "performUpdate" : { "type" : "boolean", "readOnly" : true }, "hwAddr" : { "type" : "string", "readOnly" : true }, "hmacKey" : { "type" : "string", "readOnly" : true }, "rulesVersion" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "isRcScanner" : { "type" : "boolean", "readOnly" : true } } }, "ScanLog" : { "required" : [ "source", "status" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "jobId" : { "type" : "string", "description" : "The id of the scan job" }, "status" : { "type" : "string", "description" : "The scan status", "enum" : [ "QUEUED", "PENDING", "STARTING", "RUNNING", "STOPPING", "STOPPED", "REPORTING", "FINISHED", "ISSUES", "FAILED" ] }, "scannerName" : { "type" : "string", "description" : "The scanner name", "readOnly" : true }, "statusDetails" : { "type" : "string", "description" : "The scan status details" }, "targets" : { "type" : "array", "description" : "The targets of the scan", "items" : { "type" : "string", "description" : "The targets of the scan" } }, "virtualHosts" : { "type" : "array", "description" : "The virtual hosts related to the scan", "items" : { "type" : "string", "description" : "The virtual hosts related to the scan" } }, "invocationId" : { "type" : "integer", "description" : "The ID for the same invocation scans", "format" : "int32" }, "source" : { "type" : "string", "description" : "The scan source", "enum" : [ "SCOUT", "SCALE", "SWAT", "CLOUDSEC", "NETWORK_SCAN", "DOCKER_SCAN", "DOCKER_DISCOVERY", "NETWORK_DISCOVERY", "CLOUD_DISCOVERY", "AGENT_SCAN", "WORKFLOW", "NETWORK_LOOKUP" ] }, "scanConfigurationId" : { "type" : "integer", "description" : "The id of the scan configuration", "format" : "int32" }, "scanConfigurationName" : { "type" : "string", "description" : "The name of the scan configuration", "readOnly" : true }, "workflowId" : { "type" : "integer", "description" : "The id of the workflow", "format" : "int32" }, "workflowName" : { "type" : "string", "description" : "The name of the workflow", "readOnly" : true }, "started" : { "type" : "string", "description" : "The scan started date", "format" : "date-time" }, "ended" : { "type" : "string", "description" : "The scan ended date", "format" : "date-time" }, "expectedStart" : { "type" : "string", "description" : "The scan expected start date", "format" : "date-time", "readOnly" : true }, "expectedEnd" : { "type" : "string", "description" : "The scan expected end date", "format" : "date-time", "readOnly" : true }, "blueprintAvailable" : { "type" : "boolean", "description" : "Set to true when scan blueprint is available", "readOnly" : true }, "assetIdentifierId" : { "type" : "integer", "description" : "The link id of asset on which the scan is performed", "format" : "int32" }, "assetIdentifierType" : { "type" : "string", "description" : "The type of asset on which the scan is performed", "readOnly" : true, "enum" : [ "IP", "HOSTNAME", "AWS_ACCOUNT_ID", "AWS_INSTANCE_ID", "AWS_REGION", "MAC", "NETBIOS", "GCP_PROJECT_ID", "MAZ_TENANT_ID", "MAZ_SUBSCRIPTION", "MAZ_RESOURCE_GROUP", "MAZ_RESOURCE", "DOCKER_REGISTRY", "DOCKER_IMAGE", "SEED_PATH", "AGENT", "SERIAL_MACHINE_ID", "SERIAL_PRODUCT_ID", "SERIAL_DISK_ID", "GENERIC" ] }, "assetIdentifierName" : { "type" : "string", "description" : "The name of asset on which the scan is performed", "readOnly" : true }, "assetId" : { "type" : "integer", "description" : "The id of asset on which the scan is performed", "format" : "int32" }, "assetName" : { "type" : "string", "description" : "The name of asset on which the scan is performed", "readOnly" : true }, "latestRuleDate" : { "type" : "string", "description" : "The latest rule date taken into account to perform the scan", "format" : "date-time" }, "scanless" : { "type" : "boolean", "description" : "Set to true when scan is scanless (eg only detection performed)" }, "parentId" : { "type" : "integer", "description" : "The id of the parent scan.", "format" : "int32" }, "scheduleId" : { "type" : "integer", "description" : "The schedule id when scan triggered by a schedule.", "format" : "int32" }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "authentication" : { "type" : "array", "description" : "The authentication used in the scan", "items" : { "$ref" : "#/components/schemas/ScanLog.Authentication" } } } }, "ScanLogMetadata" : { "type" : "object", "properties" : { "schema" : { "type" : "string", "readOnly" : true }, "attacker" : { "type" : "string", "readOnly" : true } } }, "ScheduledReport" : { "required" : [ "deliveryMethod", "name", "report", "scope" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The scheduled report name" }, "enabled" : { "type" : "boolean", "description" : "The scheduled report status. Set to true when enabled" }, "lastSent" : { "type" : "string", "description" : "Time report was last sent", "format" : "date-time", "readOnly" : true }, "scheduleIds" : { "type" : "array", "description" : "Schedule IDs", "readOnly" : true, "items" : { "type" : "integer", "description" : "Schedule IDs", "format" : "int32", "readOnly" : true } }, "nextOccurrence" : { "type" : "string", "description" : "Next occurrence", "format" : "date-time", "readOnly" : true }, "workflowId" : { "type" : "integer", "description" : "The workflow ID associated with this report", "format" : "int32" }, "deliveryMethod" : { "$ref" : "#/components/schemas/DeliveryMethod" }, "scope" : { "$ref" : "#/components/schemas/ScheduledReport.Scope" }, "report" : { "$ref" : "#/components/schemas/ScheduledReport.Report" }, "tags" : { "type" : "array", "description" : "Scheduled report tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "ScheduledReport.Report" : { "required" : [ "formats", "type" ], "type" : "object", "properties" : { "formats" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "PDF", "EXCEL", "XML", "SWATDEMO" ] } }, "type" : { "type" : "string", "enum" : [ "Technical", "Trend", "GroupVulnerability", "Delta", "Pci", "WasDiscovery", "Discovery", "SolutionTaskReport", "SolutionTargetReport", "GroupTrending", "GroupDelta", "Compliance", "Consumption" ] }, "viewTemplateId" : { "type" : "integer", "format" : "int32" }, "viewTemplateName" : { "type" : "string" }, "level" : { "type" : "string", "enum" : [ "Detailed", "Management", "Summary" ] }, "product" : { "type" : "string", "enum" : [ "Normal", "Pci", "Was", "SWAT", "Compliance", "Appsec Scale", "APPSEC", "CLOUDSEC" ] }, "password" : { "type" : "string" }, "executiveSummary" : { "type" : "boolean" }, "zip" : { "type" : "boolean" }, "timeFrame" : { "type" : "string", "enum" : [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "LAST_QUARTER", "LAST_YEAR", "CUSTOM", "ALL_TIME" ] }, "startDate" : { "type" : "string", "format" : "date-time" }, "endDate" : { "type" : "string", "format" : "date-time" } }, "description" : "Scheduled report configuration" }, "ScheduledReport.Scope" : { "type" : "object", "properties" : { "assetIds" : { "type" : "array", "description" : "Array of asset IDs to include in report scope", "items" : { "type" : "integer", "description" : "Array of asset IDs to include in report scope", "format" : "int32" } }, "assetGroupIds" : { "type" : "array", "description" : "Array of asset group IDs to include in report scope", "items" : { "type" : "integer", "description" : "Array of asset group IDs to include in report scope", "format" : "int32" } }, "tagIds" : { "type" : "array", "description" : "Array of tag IDs to filter report scope", "items" : { "type" : "integer", "description" : "Array of tag IDs to filter report scope", "format" : "int32" } } }, "description" : "Report scope including assets, asset groups and tags" }, "Schedule" : { "required" : [ "frequency", "interval", "name", "startsFrom" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The schedule name" }, "enabled" : { "type" : "boolean", "description" : "The schedule status. Set to true when enabled" }, "frequency" : { "type" : "string", "description" : "The schedule frequency", "enum" : [ "NONE", "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "interval" : { "type" : "integer", "description" : "The schedule interval", "format" : "int32" }, "weekdays" : { "type" : "array", "description" : "The schedule weekdays set what weekdays have been selected for recurrence", "items" : { "type" : "string", "description" : "The schedule weekdays set what weekdays have been selected for recurrence", "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "days" : { "type" : "array", "description" : "The schedule days set what days have been selected for recurrence", "items" : { "type" : "integer", "description" : "The schedule days set what days have been selected for recurrence", "format" : "int32" } }, "nthDays" : { "type" : "array", "description" : "The schedule nthDays set what ordinal days have been selected for recurrence", "items" : { "type" : "integer", "description" : "The schedule nthDays set what ordinal days have been selected for recurrence", "format" : "int32" } }, "weeks" : { "type" : "array", "description" : "The schedule weeks set what weeks have been selected for recurrence", "items" : { "type" : "integer", "description" : "The schedule weeks set what weeks have been selected for recurrence", "format" : "int32" } }, "months" : { "type" : "array", "description" : "The schedule months set what months have been selected for recurrence", "items" : { "type" : "string", "description" : "The schedule months set what months have been selected for recurrence", "enum" : [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] } }, "remainingOccurrences" : { "minimum" : 0, "type" : "integer", "description" : "The schedule remaining occurrences", "format" : "int32" }, "scanConfigurationIds" : { "type" : "array", "description" : "The scan configuration IDs associated with this schedule", "readOnly" : true, "items" : { "type" : "integer", "description" : "The scan configuration IDs associated with this schedule", "format" : "int32", "readOnly" : true } }, "workflowIds" : { "type" : "array", "description" : "The workflow IDs associated with this schedule", "readOnly" : true, "items" : { "type" : "integer", "description" : "The workflow IDs associated with this schedule", "format" : "int32", "readOnly" : true } }, "scheduledReportIds" : { "type" : "array", "description" : "The report IDs associated with this schedule", "readOnly" : true, "items" : { "type" : "integer", "description" : "The report IDs associated with this schedule", "format" : "int32", "readOnly" : true } }, "timezone" : { "type" : "string", "description" : "The schedule time zone" }, "scanWindowDuration" : { "minimum" : 1, "type" : "integer", "description" : "The schedule scan window duration.", "format" : "int32", "default" : 12 }, "startsFrom" : { "type" : "string", "description" : "The schedule starts from date", "format" : "date-time" }, "until" : { "type" : "string", "description" : "The schedule until date", "format" : "date-time" }, "nextOccurrence" : { "type" : "string", "description" : "The schedule next occurrence date", "format" : "date-time", "readOnly" : true }, "blockedTimeSlots" : { "$ref" : "#/components/schemas/Schedule.BlockedTimeSlots" } } }, "Schedule.BlockedTimeSlots" : { "type" : "object", "properties" : { "monday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "tuesday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "wednesday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "thursday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "friday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "saturday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "sunday" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, "description" : "The schedule blocked time slots" }, "ScopingInformation" : { "required" : [ "assetIdentifierIds", "targetSolution", "targetStartDate" ], "type" : "object", "properties" : { "targetSolution" : { "type" : "string", "enum" : [ "Appsec SWAT", "Appsec Snapshot", "Appsec Assure" ] }, "targetStartDate" : { "type" : "string", "format" : "date-time" }, "assetIdentifierIds" : { "minItems" : 1, "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "adminUrls" : { "type" : "array", "items" : { "type" : "string" } }, "outOfScopeUrls" : { "type" : "array", "items" : { "type" : "string" } }, "knownSensitiveFunctionality" : { "type" : "string" }, "rolesAndCredentials" : { "type" : "string" }, "componentsAndTechnologies" : { "type" : "string" }, "focusAreas" : { "type" : "string" } } }, "ChangePasswordRequest" : { "required" : [ "oldPassword", "password" ], "type" : "object", "properties" : { "password" : { "minLength" : 1, "type" : "string" }, "oldPassword" : { "minLength" : 1, "type" : "string" } } }, "SubUser" : { "required" : [ "email", "firstName", "lastName", "username" ], "type" : "object", "properties" : { "timezone" : { "type" : "string", "description" : "The user time zone" }, "portalPreferences" : { "type" : "string", "description" : "The user portal preferences" }, "customerId" : { "type" : "integer", "description" : "The user customer id", "format" : "int32", "readOnly" : true }, "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "subUser" : { "type" : "boolean", "readOnly" : true }, "username" : { "maxLength" : 64, "minLength" : 0, "type" : "string" }, "firstName" : { "maxLength" : 100, "minLength" : 0, "type" : "string" }, "lastName" : { "maxLength" : 100, "minLength" : 0, "type" : "string" }, "email" : { "type" : "string" }, "emailEncryptionKey" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "stateCode" : { "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "mobilePhone" : { "type" : "string" }, "lastLogonIp" : { "type" : "string", "readOnly" : true }, "lastLogonDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "logons" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "language" : { "type" : "string" }, "twoFactorCode" : { "type" : "string" }, "subParentId" : { "type" : "integer", "format" : "int64" }, "superUser" : { "type" : "boolean" }, "snapshotSubscriptions" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "snapshotSubscriptionsRemaining" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "swatSubscriptions" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "swatSubscriptionsRemaining" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "userRoleIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "resourceGroupIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "userRolePermissions" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true, "enum" : [ "ASSETS_VIEW", "ASSETS_VIEW_AND_MANAGE", "SCAN_CONFIGURATIONS_VIEW", "SCAN_CONFIGURATIONS_VIEW_AND_MANAGE", "SCHEDULES_VIEW", "SCHEDULES_VIEW_AND_MANAGE", "SCANS_VIEW", "SCANS_VIEW_AND_MANAGE", "FINDINGS_VIEW", "FINDINGS_VIEW_AND_MANAGE", "TAGS_MANAGE", "REPORTS_VIEW_AND_MANAGE", "USERS_VIEW", "USERS_VIEW_AND_MANAGE", "ACCOUNTS_VIEW", "ACCOUNTS_VIEW_AND_MANAGE", "SCOPING_SUBMIT", "AUDITS_VIEW", "SCHEDULED_REPORTS_VIEW", "SCHEDULED_REPORTS_VIEW_AND_MANAGE", "MANAGED_REPORTS_VIEW", "MANAGED_REPORTS_VIEW_AND_MANAGE", "DASHBOARDS_VIEW", "DASHBOARDS_VIEW_AND_MANAGE", "INTEGRATIONS_VIEW", "INTEGRATIONS_VIEW_AND_MANAGE", "COMPLIANCE_VIEW", "COMPLIANCE_VIEW_AND_MANAGE", "APPSTAKS_VIEW", "APPSTAKS_VIEW_AND_MANAGE", "UNIFIED_VIEW_VIEW", "VIEW_TEMPLATES_VIEW", "VIEW_TEMPLATES_VIEW_AND_MANAGE", "EVENT_SUBSCRIPTIONS_VIEW", "EVENT_SUBSCRIPTIONS_VIEW_AND_MANAGE", "SCAN_POLICIES_VIEW", "SCAN_POLICIES_VIEW_AND_MANAGE", "ASSET_GROUPS_VIEW", "ASSET_GROUPS_VIEW_AND_MANAGE", "FINDINGS_MANAGE_TAGS", "FINDINGS_MARK_AS_FIXED", "FINDINGS_REQUEST_VERIFICATION", "FINDINGS_CHANGE_RISK", "FINDINGS_ACCEPT_RISK", "FINDINGS_MARK_AS_FALSE_POSITIVE", "FINDINGS_COMMENT", "SUBSCRIPTIONS_VIEW", "FINDING_TEMPLATES_VIEW", "FINDING_TEMPLATES_VIEW_AND_MANAGE", "SUBSCRIPTIONS_VIEW_AND_MANAGE", "ENGAGEMENT_REQUESTS_VIEW", "ENGAGEMENT_REQUESTS_VIEW_AND_MANAGE", "APPLIANCES_VIEW", "AUTOMATION_RULES_VIEW", "AUTOMATION_RULES_VIEW_AND_MANAGE" ] } }, "allowedCustomerTagIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "roles" : { "type" : "string", "description" : "The user's roles", "readOnly" : true }, "pgpPublicKey" : { "type" : "string", "description" : "This user's PGP public key" }, "twoFactorType" : { "type" : "string", "description" : "The sub-user's two-factor authentication type", "enum" : [ "ANY", "NONE", "SMS", "TOTP" ] }, "tags" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "allowedCustomerTags" : { "type" : "array", "description" : "The allowed customer tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "twoFactorSecret" : { "type" : "string", "description" : "The sub-user's two-factor secret" } } }, "SubscriptionAudit" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true }, "action" : { "type" : "string", "readOnly" : true }, "time" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "ip" : { "type" : "string", "readOnly" : true }, "comment" : { "type" : "string", "readOnly" : true }, "username" : { "type" : "string", "readOnly" : true }, "customerName" : { "type" : "string", "readOnly" : true } } }, "Associations" : { "type" : "object", "properties" : { "assetGroups" : { "type" : "array", "items" : { "type" : "string" } } } }, "CachedSubscription" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The ID of the cached subscription", "format" : "int32", "readOnly" : true }, "uuid" : { "type" : "string", "description" : "The UUID of the subscription", "readOnly" : true }, "type" : { "type" : "string", "description" : "The type of the subscription", "readOnly" : true, "enum" : [ "DAST", "SCALE", "SCOUT", "SNAPSHOT", "SNAPSHOT_API", "SNAPSHOT_MOBILE", "ASSURE", "DAST_EXPERT", "VERIFY", "SWAT", "CLOUDSEC", "NETSEC", "CONSUMPTION", "OFFSEC", "VERIFICATION" ] }, "redeemableUntil" : { "type" : "string", "description" : "The date upto which point the subscription can be redeemed", "format" : "date-time", "readOnly" : true }, "activatedAt" : { "type" : "string", "description" : "The subscription's activation start date", "format" : "date-time", "readOnly" : true }, "activeUntil" : { "type" : "string", "description" : "The subscription's activation end date", "format" : "date-time", "readOnly" : true }, "durationInDays" : { "type" : "integer", "description" : "The subscription's duration in days", "format" : "int32", "readOnly" : true }, "elapsedDays" : { "type" : "integer", "description" : "Elapsed days of the subscription's activation period", "format" : "int32", "readOnly" : true }, "remainingDays" : { "type" : "integer", "description" : "Remaining days of the subscription's activation period", "format" : "int32", "readOnly" : true }, "isActive" : { "type" : "boolean", "description" : "Whether the subscription is active", "readOnly" : true }, "customerUuid" : { "type" : "string", "description" : "The subscription's customer UUID", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The subscription's customer ID", "format" : "int32", "readOnly" : true }, "customerName" : { "type" : "string", "description" : "The subscription's customer name", "readOnly" : true }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the subscription", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the subscription", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the subscription", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the subscription", "format" : "int32", "readOnly" : true }, "deleted" : { "type" : "string", "description" : "deleted timestamp of the subscription", "format" : "date-time", "readOnly" : true }, "associations" : { "$ref" : "#/components/schemas/Associations" }, "template" : { "$ref" : "#/components/schemas/Subscription.Template" }, "limits" : { "$ref" : "#/components/schemas/Subscription.Limits" }, "customer" : { "$ref" : "#/components/schemas/Subscription.Customer" }, "duration" : { "type" : "object", "properties" : { "seconds" : { "type" : "integer", "format" : "int64" }, "zero" : { "type" : "boolean" }, "nano" : { "type" : "integer", "format" : "int32" }, "negative" : { "type" : "boolean" }, "units" : { "type" : "array", "items" : { "type" : "object", "properties" : { "durationEstimated" : { "type" : "boolean" }, "duration" : { "type" : "object", "properties" : { "seconds" : { "type" : "integer", "format" : "int64" }, "zero" : { "type" : "boolean" }, "nano" : { "type" : "integer", "format" : "int32" }, "negative" : { "type" : "boolean" } } }, "timeBased" : { "type" : "boolean" }, "dateBased" : { "type" : "boolean" } } } } }, "description" : "The subscription's duration, in ISO-8601 format", "readOnly" : true } } }, "SubscriptionTemplate" : { "required" : [ "name", "organization", "template" ], "type" : "object", "properties" : { "uuid" : { "type" : "string" }, "name" : { "minLength" : 1, "type" : "string" }, "organization" : { "$ref" : "#/components/schemas/SubscriptionTemplate.Organization" }, "variables" : { "type" : "string" }, "template" : { "minLength" : 1, "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "createdBy" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" } } }, "SubscriptionTemplate.Organization" : { "required" : [ "uuid" ], "type" : "object", "properties" : { "uuid" : { "minLength" : 1, "type" : "string" } } }, "SubscriptionTemplateVariable" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "The subscription template variable name" }, "description" : { "type" : "string", "description" : "The subscription template variable description" } } }, "SubscriptionTemplatePreviewRequest" : { "required" : [ "template" ], "type" : "object", "properties" : { "variables" : { "type" : "string" }, "template" : { "minLength" : 1, "type" : "string" } } }, "SubscriptionReport" : { "required" : [ "customerIds", "endDate", "startDate" ], "type" : "object", "properties" : { "customerIds" : { "minItems" : 1, "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "startDate" : { "type" : "string", "format" : "date-time" }, "endDate" : { "type" : "string", "format" : "date-time" } } }, "Summary" : { "required" : [ "assetGroupId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "content" : { "type" : "string" }, "assetGroupId" : { "type" : "integer", "format" : "int32" }, "swatScheduleId" : { "type" : "integer", "format" : "int64" }, "reviewed" : { "type" : "string", "format" : "date-time" }, "reviewedBy" : { "type" : "string" }, "reviewedById" : { "type" : "integer", "format" : "int32" }, "qualityAssured" : { "type" : "string", "format" : "date-time" }, "qualityAssuredBy" : { "type" : "string" }, "qualityAssuredById" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "string", "format" : "date-time" }, "publishedBy" : { "type" : "string" }, "publishedById" : { "type" : "integer", "format" : "int32" }, "rejected" : { "type" : "string", "format" : "date-time" }, "rejectedBy" : { "type" : "string" }, "rejectedById" : { "type" : "integer", "format" : "int32" }, "status" : { "type" : "string", "enum" : [ "PENDING_REVIEW", "PENDING_QA", "PENDING_PUBLICATION", "PUBLISHED", "REJECTED" ] } } }, "SummaryTransitionRequest" : { "required" : [ "transitionTo" ], "type" : "object", "properties" : { "transitionTo" : { "type" : "string", "enum" : [ "PENDING_REVIEW", "PENDING_QA", "PENDING_PUBLICATION", "PUBLISHED", "REJECTED" ] }, "transitionBy" : { "type" : "string" }, "transitionById" : { "type" : "integer", "format" : "int32" } } }, "TagStatistic" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "key" : { "type" : "string", "readOnly" : true }, "value" : { "type" : "string", "readOnly" : true }, "statistics" : { "$ref" : "#/components/schemas/TagStatistic.Statistics" } } }, "TagStatistic.Statistics" : { "type" : "object", "properties" : { "accounts" : { "type" : "integer", "format" : "int32" }, "assetGroups" : { "type" : "integer", "format" : "int32" }, "assets" : { "type" : "integer", "format" : "int32" }, "assetIdentifiers" : { "type" : "integer", "format" : "int32" }, "eventSubscriptions" : { "type" : "integer", "format" : "int32" }, "managedReports" : { "type" : "integer", "format" : "int32" }, "scheduledReports" : { "type" : "integer", "format" : "int32" }, "complianceFindings" : { "type" : "integer", "format" : "int32" }, "findings" : { "type" : "integer", "format" : "int32" }, "information" : { "type" : "integer", "format" : "int32" }, "scanConfigurations" : { "type" : "integer", "format" : "int32" }, "workflows" : { "type" : "integer", "format" : "int32" }, "dashboards" : { "type" : "integer", "format" : "int32" }, "integrations" : { "type" : "integer", "format" : "int32" }, "scanPolicies" : { "type" : "integer", "format" : "int32" }, "viewTemplates" : { "type" : "integer", "format" : "int32" }, "automationRules" : { "type" : "integer", "format" : "int32" }, "users" : { "type" : "integer", "format" : "int32" }, "scanConfigurationSettings" : { "type" : "integer", "format" : "int32" }, "scheduledReportSettings" : { "type" : "integer", "format" : "int32" }, "resourceGroupSettings" : { "type" : "integer", "format" : "int32" }, "automationRuleSettings" : { "type" : "integer", "format" : "int32" } }, "readOnly" : true }, "TagsTransformation" : { "type" : "object", "properties" : { "objects" : { "$ref" : "#/components/schemas/TagsTransformation.Objects" }, "from" : { "$ref" : "#/components/schemas/TagsTransformation.ToFrom" }, "to" : { "$ref" : "#/components/schemas/TagsTransformation.ToFrom" } } }, "TagsTransformation.Objects" : { "type" : "object", "properties" : { "accounts" : { "type" : "boolean" }, "assetGroups" : { "type" : "boolean" }, "assets" : { "type" : "boolean" }, "assetIdentifiers" : { "type" : "boolean" }, "eventSubscriptions" : { "type" : "boolean" }, "managedReports" : { "type" : "boolean" }, "scheduledReports" : { "type" : "boolean" }, "complianceFindings" : { "type" : "boolean" }, "findings" : { "type" : "boolean" }, "information" : { "type" : "boolean" }, "scanConfigurations" : { "type" : "boolean" }, "dashboards" : { "type" : "boolean" }, "integrations" : { "type" : "boolean" }, "scanPolicies" : { "type" : "boolean" }, "viewTemplates" : { "type" : "boolean" }, "workflows" : { "type" : "boolean" }, "automationRules" : { "type" : "boolean" }, "users" : { "type" : "boolean" }, "scanConfigurationSettings" : { "type" : "boolean" }, "scheduledReportSettings" : { "type" : "boolean" }, "resourceGroupSettings" : { "type" : "boolean" }, "automationRuleSettings" : { "type" : "boolean" } } }, "TagsTransformation.ToFrom" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "allKeys" : { "type" : "boolean" }, "value" : { "type" : "string" }, "allValues" : { "type" : "boolean" } } }, "FailedRenderError" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "details" : { "type" : "array", "items" : { "type" : "string" } } } }, "FailedRenderedOutput" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/RenderedOutput" }, { "type" : "object", "properties" : { "error" : { "$ref" : "#/components/schemas/FailedRenderError" } } } ] }, "RenderedOutput" : { "type" : "object", "properties" : { "description" : { "type" : "string" } } }, "SucceededRenderedOutput" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/RenderedOutput" }, { "type" : "object", "properties" : { "renderedOutput" : { "type" : "string" } } } ] }, "RenderContext" : { "required" : [ "trigger", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Refers to the event integration type", "enum" : [ "WEBHOOK", "EMAIL", "LOG", "SYSLOG", "SNMP", "NOTIFICATION" ] }, "trigger" : { "type" : "string", "description" : "Refers to the trigger.", "enum" : [ "SCHEDULE_CREATED", "SCHEDULE_DELETED", "SCHEDULE_MODIFIED", "SCHEDULE_SCHEDULED", "CONFIGURATION_CREATED", "CONFIGURATION_DELETED", "CONFIGURATION_MODIFIED", "CONFIGURATION_STARTED", "CONFIGURATION_DONE", "SCAN_STARTED", "SCAN_STOPPED", "SCAN_DONE", "ASSET_NOT_RECENTLY_SEEN", "ASSET_SEEN", "ASSET_CREATED", "ASSET_DELETED", "ASSET_MODIFIED", "FINDING_SEEN", "FINDING_CREATED", "FINDING_MODIFIED", "FINDING_STATUS_TRANSITIONED", "FINDING_RISK_ACCEPTED_EXPIRATION", "WATCHED_FINDING_UPDATED", "USER_CREATED", "USER_DELETED", "USER_MODIFIED", "USER_LOGIN_ATTEMPT", "USER_PASSWORD_RESET", "ROLE_CREATED", "ROLE_DELETED", "ROLE_MODIFIED", "RESOURCE_GROUP_CREATED", "RESOURCE_GROUP_DELETED", "RESOURCE_GROUP_MODIFIED", "RELEASE_NOTES_PUBLISHED", "HIAB_SCANNER_MISSING", "HIAB_UPDATE_DONE", "HIAB_UPDATE_FAILED", "HIAB_BACKUP_DONE", "HIAB_BACKUP_FAILED", "HIAB_MAINTENANCE_PLAN_DONE", "HIAB_DISK_USAGE_HIGH", "HIAB_REBOOTED", "HIAB_REMOTE_SUPPORT", "OUTSCAN_CONSULTANCY", "CONSUMPTION_ABSOLUTE", "CONSUMPTION_RELATIVE", "WORKFLOW_CREATED", "WORKFLOW_DELETED", "WORKFLOW_MODIFIED", "WORKFLOW_STARTED", "WORKFLOW_DONE", "COMPLIANCE_CREATED", "COMPLIANCE_MODIFIED", "COMPLIANCE_RISK_EXCEPTION", "COMPLIANCE_RISK_EXCEPTION_EXPIRATION", "COMMENT_CREATED", "EXECUTIVE_SUMMARY_UPDATED", "ACTIVITY_FEED_UPDATED", "ASSET_GROUP_CREATED", "ASSET_GROUP_DELETED", "ASSET_GROUP_MODIFIED", "NEWSLETTER_PUBLISHED", "COMMERCIAL_PUBLISHED", "CUSTOMER_COMMUNICATION_PUBLISHED", "INFORMATION_PRODUCT_CREATED", "INFORMATION_PRODUCT_MODIFIED", "INFORMATION_PRODUCT_SEEN", "INFORMATION_PRODUCT_EOL", "INFORMATION_PORT_CREATED", "INFORMATION_PORT_MODIFIED", "INFORMATION_PORT_SEEN", "INFORMATION_SERVICE_CREATED", "INFORMATION_SERVICE_MODIFIED", "INFORMATION_SERVICE_SEEN", "INFORMATION_CERTIFICATE_CREATED", "INFORMATION_CERTIFICATE_MODIFIED", "INFORMATION_CERTIFICATE_SEEN", "ENGAGEMENT_REQUEST_CREATED", "ENGAGEMENT_REQUEST_MODIFIED", "MANAGED_REPORT_UPLOADED", "AUTOMATION_RULE_CREATED", "AUTOMATION_RULE_DELETED", "AUTOMATION_RULE_MODIFIED", "FINDING_SCORE_CHANGE", "CHECK_SCORE_CHANGE", "FINDING_NEW_EXPLOIT", "CHECK_NEW_EXPLOIT", "AGENT_RETIRED", "AGENT_NOT_CALLHOME", "AGENT_NOT_SCAN", "AGENT_OUTDATED" ] }, "triggerValid" : { "type" : "boolean" }, "typeValid" : { "type" : "boolean" } }, "description" : "Provide additional information about the render request" }, "TemplateRenderRequest" : { "required" : [ "context", "template" ], "type" : "object", "properties" : { "template" : { "type" : "string", "description" : "Template to be rendered" }, "context" : { "$ref" : "#/components/schemas/RenderContext" } } }, "Terms" : { "required" : [ "allUsersMustAccept", "mainUserMustAccept", "termsTemplateId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "mainUserMustAccept" : { "type" : "boolean" }, "allUsersMustAccept" : { "type" : "boolean" }, "termsTemplateId" : { "type" : "integer", "format" : "int32" }, "termsTemplateName" : { "type" : "string", "readOnly" : true }, "termsTemplateContent" : { "type" : "string", "readOnly" : true }, "customerName" : { "type" : "string", "readOnly" : true } } }, "TermsAcceptance" : { "required" : [ "termsId" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "termsId" : { "type" : "integer", "format" : "int32" } } }, "UserRole" : { "required" : [ "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The user role name" }, "system" : { "type" : "boolean", "description" : "Set to true when system role", "readOnly" : true }, "permissionIds" : { "type" : "array", "description" : "The user role permission ids", "items" : { "type" : "integer", "description" : "The user role permission ids", "format" : "int32" } } } }, "TermsTemplate" : { "required" : [ "content", "name" ], "type" : "object", "properties" : { "name" : { "minLength" : 1, "type" : "string" }, "content" : { "minLength" : 1, "type" : "string" }, "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "readOnly" : true }, "updatedBy" : { "type" : "string", "readOnly" : true }, "createdById" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "format" : "int32", "readOnly" : true } } }, "UserRolePermission" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true } } }, "User" : { "required" : [ "email", "firstName", "lastName", "username" ], "type" : "object", "properties" : { "timezone" : { "type" : "string", "description" : "The user time zone" }, "portalPreferences" : { "type" : "string", "description" : "The user portal preferences" }, "customerId" : { "type" : "integer", "description" : "The user customer id", "format" : "int32", "readOnly" : true }, "id" : { "type" : "integer", "description" : "The user id", "format" : "int64", "readOnly" : true }, "company" : { "type" : "string", "description" : "The user company name", "readOnly" : true }, "firstName" : { "minLength" : 1, "type" : "string", "description" : "The user first name" }, "lastName" : { "minLength" : 1, "type" : "string", "description" : "The user last name" }, "email" : { "type" : "string", "description" : "The user email address" }, "username" : { "minLength" : 1, "type" : "string", "description" : "The user name" }, "emailEncryptionKey" : { "type" : "string", "description" : "The user public key for email encryption" }, "sshPublicKey" : { "type" : "string", "description" : "The user ssh public key" }, "mobilePhone" : { "type" : "string", "description" : "The user mobile phone number" }, "countryCode" : { "type" : "string", "description" : "The user country code" }, "stateCode" : { "type" : "string", "description" : "The user state code" }, "lastLogonIp" : { "type" : "string", "description" : "The user last logon ip address", "readOnly" : true }, "lastLogonDate" : { "type" : "string", "description" : "The user last logon date", "format" : "date-time", "readOnly" : true }, "logons" : { "type" : "integer", "description" : "The user logon numbers", "format" : "int64", "readOnly" : true }, "language" : { "type" : "string", "description" : "The user language" }, "remoteSupport" : { "type" : "boolean", "description" : "The user remote support status", "readOnly" : true }, "twoFactorCode" : { "type" : "string" }, "roles" : { "type" : "string", "description" : "The user's roles", "readOnly" : true }, "snapshotSubscriptions" : { "type" : "integer", "description" : "The snapshot subscriptions", "format" : "int64" }, "snapshotSubscriptionsRemaining" : { "type" : "integer", "description" : "The remaining snapshot subscriptions", "format" : "int64" }, "swatSubscriptions" : { "type" : "integer", "description" : "The SWAT subscriptions", "format" : "int64" }, "swatSubscriptionsRemaining" : { "type" : "integer", "description" : "The remaining SWAT subscriptions", "format" : "int64" }, "pgpPublicKey" : { "type" : "string", "description" : "This user's PGP public key" }, "twoFactorType" : { "type" : "string", "description" : "The user's two-factor authentication type", "enum" : [ "ANY", "NONE", "SMS", "TOTP" ] }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "twoFactorSecret" : { "type" : "string", "description" : "The user's two-factor secret" } } }, "ViewTemplateGroup" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "ASSET_GROUPS", "ASSETS", "SCAN_CONFIGURATIONS", "SCHEDULES", "SCANS", "FINDINGS", "REPORTS", "USERS", "ACCOUNTS", "AUDITS", "SCHEDULED_REPORTS", "MANAGED_REPORTS", "INTEGRATIONS", "COMPLIANCE", "TAGS", "VIEW_TEMPLATES", "SCAN_POLICIES", "SUBSCRIPTIONS", "SUBSCRIPTIONS_TEMPLATES", "TERMS", "TERMS_TEMPLATES", "APPLIANCES", "CUSTOMERS", "AGENTS", "CONSUMPTION", "WORKFLOWS", "CHECKS", "PRODUCT_INFORMATION", "FINDING_TEMPLATES", "MATCHES", "INFORMATION_PRODUCTS", "INFORMATION_PORTS", "INFORMATION_SERVICES", "INFORMATION_CERTIFICATES", "ENGAGEMENT_REQUESTS", "EVENT_SUBSCRIPTIONS", "AUTOMATION_RULES" ] } } }, "ViewTemplate" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ASSET_GROUPS", "ASSETS", "SCAN_CONFIGURATIONS", "SCHEDULES", "SCANS", "FINDINGS", "REPORTS", "USERS", "ACCOUNTS", "AUDITS", "SCHEDULED_REPORTS", "MANAGED_REPORTS", "INTEGRATIONS", "COMPLIANCE", "TAGS", "VIEW_TEMPLATES", "SCAN_POLICIES", "SUBSCRIPTIONS", "SUBSCRIPTIONS_TEMPLATES", "TERMS", "TERMS_TEMPLATES", "APPLIANCES", "CUSTOMERS", "AGENTS", "CONSUMPTION", "WORKFLOWS", "CHECKS", "PRODUCT_INFORMATION", "FINDING_TEMPLATES", "MATCHES", "INFORMATION_PRODUCTS", "INFORMATION_PORTS", "INFORMATION_SERVICES", "INFORMATION_CERTIFICATES", "ENGAGEMENT_REQUESTS", "EVENT_SUBSCRIPTIONS", "AUTOMATION_RULES" ] }, "sorting" : { "type" : "string" }, "fields" : { "type" : "string" }, "columnsWidth" : { "type" : "string" }, "system" : { "type" : "boolean", "readOnly" : true }, "isDefault" : { "type" : "boolean" }, "groupId" : { "type" : "integer", "description" : "The view template group id", "format" : "int32" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ViewTemplate.Filter" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } } } }, "ViewTemplate.Filter" : { "required" : [ "comparison", "field", "value" ], "type" : "object", "properties" : { "field" : { "type" : "string" }, "comparison" : { "type" : "string" }, "value" : { "type" : "string" } } }, "Workflow" : { "required" : [ "configurations", "name" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The id of the object", "format" : "int32", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "The customer id the object belongs to", "format" : "int32" }, "created" : { "type" : "string", "description" : "The created date", "format" : "date-time", "readOnly" : true }, "updated" : { "type" : "string", "description" : "The updated date", "format" : "date-time", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "The name of who created the object", "readOnly" : true }, "updatedBy" : { "type" : "string", "description" : "The name of who updated the object", "readOnly" : true }, "createdById" : { "type" : "integer", "description" : "The userid of the person that created the object", "format" : "int32", "readOnly" : true }, "updatedById" : { "type" : "integer", "description" : "The userid of the person that updated the object", "format" : "int32", "readOnly" : true }, "name" : { "minLength" : 1, "type" : "string", "description" : "The workflow name" }, "enabled" : { "type" : "boolean", "description" : "The workflow status. Set to true when enabled" }, "nextOccurrence" : { "type" : "string", "description" : "The scan next occurrence date", "format" : "date-time", "readOnly" : true }, "lastScan" : { "type" : "string", "description" : "Last time a scan was performed using this workflow", "format" : "date-time", "readOnly" : true }, "scheduleIds" : { "type" : "array", "description" : "The schedule ids associated with this workflow", "readOnly" : true, "items" : { "type" : "integer", "description" : "The schedule ids associated with this workflow", "format" : "int32", "readOnly" : true } }, "scannerId" : { "type" : "integer", "description" : "The scanner id", "format" : "int32" }, "scannerTagId" : { "type" : "integer", "description" : "The scanner tag id", "format" : "int32" }, "scannerName" : { "type" : "string", "description" : "The scanner name", "readOnly" : true }, "tags" : { "type" : "array", "description" : "The tags", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Tag" } }, "configurations" : { "type" : "array", "description" : "The workflow configurations", "items" : { "$ref" : "#/components/schemas/Workflow.Configuration" } }, "settings" : { "$ref" : "#/components/schemas/Workflow.Settings" } } }, "Workflow.Configuration" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "SCAN_CONFIGURATION", "SCHEDULED_REPORT" ] } }, "description" : "The workflow configurations" }, "Workflow.Settings" : { "type" : "object", "properties" : { "maxConcurrentScans" : { "type" : "integer", "format" : "int32" }, "maxConcurrentScansPerAsset" : { "type" : "integer", "format" : "int32" } }, "description" : "The workflow settings" } }, "securitySchemes" : { "bearerAuth" : { "type" : "http", "scheme" : "bearer", "bearerFormat" : "JWT" } } } }