diff --git a/openapi-specs/cspm/AccessKeys.json b/openapi-specs/cspm/AccessKeys.json index 1e51b7c56..d51846661 100644 --- a/openapi-specs/cspm/AccessKeys.json +++ b/openapi-specs/cspm/AccessKeys.json @@ -150,9 +150,6 @@ }, "403": { "description": "unauthorized_to_use_access_keys" - }, - "500": { - "description": "failed_fetch_user_profile" } }, "security": [ @@ -243,9 +240,6 @@ }, "403": { "description": "unauthorized_to_use_access_keys" - }, - "500": { - "description": "non_existing_access_key" } }, "security": [ @@ -282,9 +276,6 @@ }, "403": { "description": "unauthorized_to_use_access_keys" - }, - "500": { - "description": "failed_fetch_user_profile / non_existing_access_key" } }, "security": [ @@ -332,9 +323,6 @@ }, "403": { "description": "unauthorized_to_use_access_keys" - }, - "500": { - "description": "non_existing_access_key / expired_access_key" } }, "security": [ diff --git a/openapi-specs/cspm/AccountGroups.json b/openapi-specs/cspm/AccountGroups.json index aa44abd87..5ae0496fd 100644 --- a/openapi-specs/cspm/AccountGroups.json +++ b/openapi-specs/cspm/AccountGroups.json @@ -267,9 +267,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -312,9 +309,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -356,9 +350,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -410,9 +401,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -463,9 +451,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -512,9 +497,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -553,9 +535,6 @@ }, "409": { "description": "conflict_deleting_last_account_group_for_alert_rule / cannot_delete_an_account_group_associated_with_cloud_accounts" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/AdoptionAdvisor.json b/openapi-specs/cspm/AdoptionAdvisor.json index 4a84e0533..95d1fdc1f 100644 --- a/openapi-specs/cspm/AdoptionAdvisor.json +++ b/openapi-specs/cspm/AdoptionAdvisor.json @@ -333,9 +333,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -373,9 +370,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -408,9 +402,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -460,9 +451,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -494,9 +482,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -530,9 +515,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/AlertRules.json b/openapi-specs/cspm/AlertRules.json index 7cd01fa79..365be58a3 100644 --- a/openapi-specs/cspm/AlertRules.json +++ b/openapi-specs/cspm/AlertRules.json @@ -544,9 +544,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -588,9 +585,6 @@ }, "400": { "description": "invalid_param_value / auto_remediation_only_for_config_remediable_policies / missing_required_param / non_notification_state_selected / invalid_notification_state / invalid_resource_list_id / snooze_time_must_be_relative / dismissal_reason_required / has_overlaps_in_resource_list_rules / missing_required_param" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -638,9 +632,6 @@ }, "404": { "description": "no_results" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -694,9 +685,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -732,9 +720,6 @@ }, "403": { "description": "incomplete_account_group_access" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/Alerts.json b/openapi-specs/cspm/Alerts.json index 8a7365dd0..e06ec3e47 100644 --- a/openapi-specs/cspm/Alerts.json +++ b/openapi-specs/cspm/Alerts.json @@ -3548,9 +3548,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/AlertsMicroServices.json b/openapi-specs/cspm/AlertsMicroServices.json index 67372a28a..802dd508f 100644 --- a/openapi-specs/cspm/AlertsMicroServices.json +++ b/openapi-specs/cspm/AlertsMicroServices.json @@ -101,16 +101,6 @@ } } } - }, - "5XX": { - "description": "Server error", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } } }, "security": [ @@ -169,16 +159,6 @@ } } } - }, - "5XX": { - "description": "Server error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } } }, "security": [ @@ -269,16 +249,6 @@ } } } - }, - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } } }, "security": [ @@ -1527,6 +1497,9 @@ "type": "boolean" }, "timeRange": { + "discriminator": { + "propertyName": "type" + }, "oneOf": [ { "$ref": "#/components/schemas/AbsoluteTimeRangeConfig" @@ -1710,10 +1683,7 @@ "type": "string" } }, - "description": "Model for TimeRangeConfig", - "discriminator": { - "propertyName": "type" - } + "description": "Model for TimeRangeConfig" }, "ToNowTimeRangeConfig": { "type": "object", @@ -3936,19 +3906,17 @@ "properties": { "nodes": { "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssetNode" - }, - { - "$ref": "#/components/schemas/FindingNode" - }, - { - "$ref": "#/components/schemas/VulnerabilityNode" - } - ] - } + "oneOf": [ + { + "$ref": "#/components/schemas/AssetNode" + }, + { + "$ref": "#/components/schemas/FindingNode" + }, + { + "$ref": "#/components/schemas/VulnerabilityNode" + } + ] }, "edges": { "type": "array", @@ -3994,19 +3962,11 @@ }, "AssetNode": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Node" - }, - { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/AssetNodeMetadata" - } - } + "properties": { + "metadata": { + "$ref": "#/components/schemas/AssetNodeMetadata" } - ] + } }, "AssetNodeMetadata": { "type": "object", @@ -4212,26 +4172,18 @@ "type" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Node" + "properties": { + "type": { + "type": "string", + "description": "The node type", + "enum": [ + "Finding" + ] }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The node type", - "enum": [ - "Finding" - ] - }, - "metadata": { - "$ref": "#/components/schemas/FindingNodeMetadata" - } - } + "metadata": { + "$ref": "#/components/schemas/FindingNodeMetadata" } - ] + } }, "FindingNodeMetadata": { "required": [ @@ -4487,26 +4439,18 @@ "type" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Node" + "properties": { + "type": { + "type": "string", + "description": "The node type", + "enum": [ + "Vulnerability" + ] }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The node type", - "enum": [ - "Vulnerability" - ] - }, - "metadata": { - "$ref": "#/components/schemas/VulnerabilityMetadata" - } - } + "metadata": { + "$ref": "#/components/schemas/VulnerabilityMetadata" } - ] + } } }, "headers": { diff --git a/openapi-specs/cspm/ArchivedAssetsMicroService.json b/openapi-specs/cspm/ArchivedAssetsMicroService.json index 5c93005f4..2e1d5057c 100644 --- a/openapi-specs/cspm/ArchivedAssetsMicroService.json +++ b/openapi-specs/cspm/ArchivedAssetsMicroService.json @@ -220,21 +220,6 @@ } } } - }, - "500": { - "description": "Failed with an Exception, Internal Error Occurred", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - }, - "example": { - "status": "Internal Server Error", - "timestamp": "string", - "message": "string" - } - } - } } }, "x-microservice": "true", diff --git a/openapi-specs/cspm/AssetExplorer.json b/openapi-specs/cspm/AssetExplorer.json index 398bdb907..be038c360 100644 --- a/openapi-specs/cspm/AssetExplorer.json +++ b/openapi-specs/cspm/AssetExplorer.json @@ -695,9 +695,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -732,9 +729,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -936,9 +930,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -980,9 +971,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1144,9 +1132,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1187,9 +1172,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/AssetInventory.json b/openapi-specs/cspm/AssetInventory.json index d9d6f2a9a..9031cdacc 100644 --- a/openapi-specs/cspm/AssetInventory.json +++ b/openapi-specs/cspm/AssetInventory.json @@ -695,9 +695,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -765,9 +762,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_inventory_saved_filters" } }, "security": [ @@ -798,9 +792,6 @@ }, "400": { "description": "failed_add_inventory_saved_filter" - }, - "500": { - "description": "failed_add_inventory_saved_filter" } }, "security": [ @@ -839,9 +830,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_inventory_saved_filter" } }, "security": [ @@ -883,9 +871,6 @@ }, "400": { "description": "failed_update_inventory_saved_filter" - }, - "500": { - "description": "failed_update_inventory_saved_filter" } }, "security": [ @@ -921,9 +906,6 @@ }, "403": { "description": "not_owner_or_same_role" - }, - "500": { - "description": "failed_add_inventory_saved_filter" } }, "security": [ @@ -1111,9 +1093,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1152,9 +1131,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1340,9 +1316,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1384,9 +1357,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1535,9 +1505,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1575,9 +1542,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1724,9 +1688,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1767,9 +1728,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/AssetMicroService.json b/openapi-specs/cspm/AssetMicroService.json index 30fc7561a..b6b228401 100644 --- a/openapi-specs/cspm/AssetMicroService.json +++ b/openapi-specs/cspm/AssetMicroService.json @@ -74,7 +74,7 @@ "Asset Explorer" ], "summary": "Get Asset", - "description": "Returns detailed information for the asset with the given id.\n\nThe data field in the response object contains the raw JSON blob as returned by the source cloud service provider API for the given asset.\n\nOnly the rrn parameter in the request body is used for this API. Ignore the timelineItemId and findingType fields.\n\n Ensure to add the required parameters for the asset query type as follows: \n\n | **Asset Domain Service Query Type** | **Required Parameters** |\n| ------------------------------- | ----------------------------------------------------------------- |\n| External_finding | |\n| alerts | alertids |\n| attackpath | attackPathIds |\n| package_info | |\n| labels | filters |\n| vulnerability_aggregates | filters |\n| process_info | filters |\n| vulnerabilities_group_by_type | |\n| asset_cwp_vulns | |\n\n", + "description": "Returns detailed information for the asset with the given id.\n\nThe data field in the response object contains the raw JSON blob as returned by the source cloud service provider API for the given asset.\n\nOnly the rrn parameter in the request body is used for this API. Ignore the timelineItemId and findingType fields.\n\n Ensure to add the required parameters for the asset query parameter with type as follows: \n\n | **Type** | **Conditionally Required Query Parameters** |\n| ------------------------------- | ----------------------------------------------------------------- |\n| external_finding | |\n| alerts | alertIds |\n| attack_path | attackPathIds |\n| package_info | |\n| labels | filters |\n| vulnerability_aggregates | filters |\n| process_info | filters |\n| vulnerabilities_group_by_type | |\n| asset_cwp_vulns | |\n\n", "operationId": "get-asset-details-by-id", "parameters": [ { @@ -310,10 +310,7 @@ }, "AssetRequest": { "required": [ - "alertIds", "assetId", - "attackPathIds", - "prismaCloudFindingsOnly", "type" ], "type": "object", diff --git a/openapi-specs/cspm/BackgroundJobsMicroService.json b/openapi-specs/cspm/BackgroundJobsMicroService.json new file mode 100644 index 000000000..2a1148b90 --- /dev/null +++ b/openapi-specs/cspm/BackgroundJobsMicroService.json @@ -0,0 +1,661 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Platform: Reporting Service", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ], + "tags": [ + { + "name": "Background Jobs", + "description": "Background jobs is an asynchronous way of managing the report. When you want to download the results up to 100k records, you can create a background job and use the available apis to check the job status, download the report once finished and list all the background jobs created in past 30 Days." + } + ], + "paths": { + "/report-service/api/v1/report": { + "get": { + "tags": [ + "Background Jobs" + ], + "summary": "Get Reports Metadata", + "description": "List the reports metadata for given report types\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "list-reports", + "parameters": [ + { + "name": "report_types", + "in": "query", + "description": "Report types to be retrieved. You can specify multiple report types as comma separated values", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "The required page number for the paginated results. Page number starts from the 0. Default value is 0", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "size", + "in": "query", + "description": "The number of results to be returned as part of the page response. Default value is 100", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListJobResponseModel" + } + } + } + }, + "400": { + "description": "Bad Request - report types not specified", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "401": { + "description": "Unauthorized - user cannot be authenticated to service the request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "403": { + "description": "Forbidden - user role can not be determined", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-public": "true", + "x-ga": "24.1.1-darwin" + } + }, + "/report-service/api/v1/report/{reportId}": { + "get": { + "tags": [ + "Background Jobs" + ], + "summary": "Get Report Metadata by ID", + "description": "Get the metadata for the given report id\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "get-report-metadata-by-id", + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "Id of the report for which the metadata to retrieved.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListReportDetails" + } + } + } + }, + "401": { + "description": "Unauthorized - user cannot be authenticated to service the request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "403": { + "description": "Forbidden - user does not have the required role", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "404": { + "description": "Not Found - report not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-public": "true", + "x-ga": "24.1.1-darwin" + } + }, + "/report-service/api/v1/report/{reportId}/status": { + "get": { + "tags": [ + "Background Jobs" + ], + "summary": "Get Report Status", + "description": "Get the status for the given report id\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "get-report-status-by-id", + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "Id of the report for which status to be retrieved.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReportResponse" + } + } + } + }, + "401": { + "description": "Unauthorized - user cannot be authenticated to service the request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "403": { + "description": "Forbidden - user does not have the required role", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "404": { + "description": "Not Found - report not found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-public": "true", + "x-ga": "24.1.1-darwin" + } + }, + "/report-service/api/v1/report/{reportId}/download": { + "get": { + "tags": [ + "Background Jobs" + ], + "summary": "Download a report", + "description": "Download the report by given report id. Output format can vary with the different report type. Possible formats can be of zip, json.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "download-report-by-id", + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "Id of the report to be downloaded.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful operation" + }, + "401": { + "description": "Unauthorized - user cannot be authenticated to service the request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "403": { + "description": "Forbidden - user does not have the required role", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + }, + "404": { + "description": "Not Found - report not found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResponseStatus" + } + } + } + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-public": "true", + "x-ga": "24.1.1-darwin" + } + } + }, + "components": { + "schemas": { + "ReportResponse": { + "type": "object", + "properties": { + "reportId": { + "type": "string", + "description": "Id of the report being created." + }, + "createdBy": { + "type": "string", + "description": "User who created the report." + }, + "createdOn": { + "type": "integer", + "description": "Timestamp when report request is created.", + "format": "int64" + }, + "status": { + "type": "string", + "description": "Current status of the report." + }, + "statusUrl": { + "type": "string", + "description": "Url to check the report status." + }, + "downloadUrl": { + "type": "string", + "description": "Url to download the report once report is generated." + } + } + }, + "ResponseStatus": { + "type": "object", + "properties": { + "i18nKey": { + "type": "string" + }, + "severity": { + "type": "string", + "enum": [ + "ERROR", + "INFO", + "WARNING" + ] + }, + "subject": { + "type": "string" + }, + "statusCode": { + "type": "integer", + "format": "int32" + } + } + }, + "CreateReportRequest": { + "required": [ + "clientType", + "dataProducerMeta", + "reportFormat", + "reportType", + "submittedBy" + ], + "type": "object", + "properties": { + "clientType": { + "type": "string", + "description": "Client identifier.", + "enum": [ + "Alert", + "AssetSearch", + "AssetExplorer", + "Rql" + ] + }, + "reportType": { + "type": "string", + "description": "Type of the report to be generated." + }, + "reportFormat": { + "type": "string", + "description": "Report file format. Example csv, json etc" + }, + "dataProducerMeta": { + "$ref": "#/components/schemas/DataApi" + }, + "submittedBy": { + "$ref": "#/components/schemas/UserMeta" + }, + "reportConfig": { + "$ref": "#/components/schemas/ReportConfig" + } + } + }, + "DataApi": { + "type": "object", + "properties": { + "urlPathVariables": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Specify if any path variables are to be send to data generation endpoint. Map the path variables and their values." + }, + "description": "Specify if any path variables are to be send to data generation endpoint. Map the path variables and their values." + }, + "urlQueryParams": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Specify if any query parameters are to be send to data generation endpoint. Map the query parameters and their values." + }, + "description": "Specify if any query parameters are to be send to data generation endpoint. Map the query parameters and their values." + }, + "requestHeaders": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Specify if any headers are to be send to data generation endpoint. Map the headers and their values." + }, + "description": "Specify if any headers are to be send to data generation endpoint. Map the headers and their values." + }, + "requestBody": { + "$ref": "#/components/schemas/JsonNode" + } + }, + "description": "Data needed to send to the data generation endpoint" + }, + "JsonNode": { + "type": "object", + "description": "Specify if any request body to be send to data generation endpoint. Specify the request body as json." + }, + "ReportConfig": { + "type": "object", + "properties": { + "maxRecordsPerFile": { + "type": "integer", + "description": "Maximum number of records per file. This value is checked before writing the new page results to the same batch file. If the specified value is not a multiple of the page size then a batch file can have more records than the specified value here", + "format": "int64" + }, + "maxFileSizeInBytes": { + "type": "integer", + "description": "Maximum number of bytes per file. This value is checked before writing the new page results to the same batch file. There is a possibility that file size won't be exact specified limit.", + "format": "int64" + }, + "maxTotalRecords": { + "type": "integer", + "description": "Maximum number of records to be generated.", + "format": "int64" + } + }, + "description": "Report configuration to customize the generated report as batch files." + }, + "UserMeta": { + "required": [ + "activeRoleId", + "customerName", + "prismaId", + "roleType", + "userName" + ], + "type": "object", + "properties": { + "prismaId": { + "type": "integer", + "description": "Prisma Id of the tenant.", + "format": "int64" + }, + "customerName": { + "type": "string", + "description": "Name of the customer." + }, + "userName": { + "type": "string", + "description": "User creating the report." + }, + "activeRoleId": { + "type": "string", + "description": "Role id of the logged-in user." + }, + "roleType": { + "type": "string", + "description": "Permission group of the logged-in user." + }, + "timeZone": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "id": { + "type": "string" + }, + "dstsavings": { + "type": "integer", + "format": "int32" + }, + "rawOffset": { + "type": "integer", + "format": "int32" + } + }, + "description": "User's local time zone." + } + }, + "description": "Report created user metadata." + }, + "ListJobResponseModel": { + "type": "object", + "properties": { + "reports": { + "type": "array", + "description": "Report metadata list.", + "items": { + "$ref": "#/components/schemas/ListReportDetails" + } + }, + "currentPage": { + "type": "integer", + "description": "Current page number.", + "format": "int64" + }, + "totalItems": { + "type": "integer", + "description": "Total number of the available reports.", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "Total number of pages to fetch the reports.", + "format": "int64" + }, + "pageSize": { + "type": "integer", + "description": "Number of records per page.", + "format": "int64" + } + } + }, + "ListReportDetails": { + "type": "object", + "properties": { + "reportId": { + "type": "string", + "description": "Id of the report.", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "Status of the report." + }, + "reportType": { + "type": "string", + "description": "Type of the report." + }, + "clientType": { + "type": "string", + "description": "Client identifier." + }, + "payload": { + "type": "object", + "description": "Payload used for creating the report." + }, + "pathVariables": { + "type": "object", + "description": "Path variables used for creating the report." + }, + "queryParams": { + "type": "object", + "description": "Query params used for creating the report." + }, + "requestHeaders": { + "type": "object", + "description": "Request headers used for creating the report." + }, + "additionalInformation": { + "type": "object", + "description": "Any additional attributes used for creating the report." + }, + "createdOn": { + "type": "integer", + "description": "Timestamp when report request is created.", + "format": "int64" + }, + "downloadUrl": { + "type": "string", + "description": "Url to download the report once report is generated." + } + } + } + }, + "headers": { + "prismaId": { + "description": "x-prisma-tenant-id", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + } +} diff --git a/openapi-specs/cspm/CloudAccounts(AWS).json b/openapi-specs/cspm/CloudAccounts(AWS).json index f75d3841e..5f3a07e5f 100644 --- a/openapi-specs/cspm/CloudAccounts(AWS).json +++ b/openapi-specs/cspm/CloudAccounts(AWS).json @@ -625,9 +625,6 @@ }, "412": { "description": "external_id_empty_or_not_generated. To generate CFT and externalId call **[Generate and Download the AWS CFT Template endpoint](/prisma-cloud/api/cspm/generate-cft-template-aws)** or **[Generate the AWS CFT Template Link Endpoint](/prisma-cloud/api/cspm/generate-cft-template-link-aws)**" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -688,9 +685,6 @@ }, "412": { "description": "external_id_empty_or_not_generated. To generate CFT and externalId call **[Generate and Download the AWS CFT Template endpoint](/prisma-cloud/api/cspm/generate-cft-template-aws)** or **[Generate the AWS CFT Template Link Endpoint](/prisma-cloud/api/cspm/generate-cft-template-link-aws)**" - }, - "500": { - "description": "not_found / internal_error" } }, "security": [ @@ -736,9 +730,6 @@ }, "412": { "description": "external_id_empty_or_not_generated. To generate CFT and externalId call **[Generate and Download the AWS CFT Template endpoint](/prisma-cloud/api/cspm/generate-cft-template-aws)** or **[Generate the AWS CFT Template Link Endpoint](/prisma-cloud/api/cspm/generate-cft-template-link-aws)**" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -786,9 +777,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -826,9 +814,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -864,9 +849,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -906,9 +888,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1002,9 +981,6 @@ }, "400": { "description": "permission_error / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1066,9 +1042,6 @@ }, "404": { "description": "invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1162,9 +1135,6 @@ }, "412": { "description": "external_id_empty_or_not_generated. To generate CFT and externalId call **[Generate and Download the AWS CFT Template endpoint](/prisma-cloud/api/cspm/generate-cft-template-aws)** or **[Generate the AWS CFT Template Link Endpoint](/prisma-cloud/api/cspm/generate-cft-template-link-aws)**" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1226,9 +1196,6 @@ }, "412": { "description": "external_id_empty_or_not_generated. To generate CFT and externalId call **[Generate and Download the AWS CFT Template endpoint](/prisma-cloud/api/cspm/generate-cft-template-aws)** or **[Generate the AWS CFT Template Link Endpoint](/prisma-cloud/api/cspm/generate-cft-template-link-aws)**" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/CloudAccounts(All).json b/openapi-specs/cspm/CloudAccounts(All).json index ec7a45ea2..7eed82973 100644 --- a/openapi-specs/cspm/CloudAccounts(All).json +++ b/openapi-specs/cspm/CloudAccounts(All).json @@ -2110,9 +2110,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2322,9 +2319,6 @@ }, "400": { "description": "not_found / not_an_org" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2466,9 +2460,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2597,9 +2588,6 @@ }, "405": { "description": "cloud_account_already_enabled / cloud_account_already_disabled" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2654,9 +2642,6 @@ }, "404": { "description": "invalid_cloud_type / invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/CloudAccounts(Azure).json b/openapi-specs/cspm/CloudAccounts(Azure).json index b32559a16..8f91380ae 100644 --- a/openapi-specs/cspm/CloudAccounts(Azure).json +++ b/openapi-specs/cspm/CloudAccounts(Azure).json @@ -352,9 +352,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -412,9 +409,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "not_found / internal_error" } }, "security": [ @@ -457,9 +451,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -518,9 +509,6 @@ }, "400": { "description": "bad_request / unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -580,9 +568,6 @@ }, "404": { "description": "invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/CloudAccounts(GCP).json b/openapi-specs/cspm/CloudAccounts(GCP).json index 449270acf..1e3a7e246 100644 --- a/openapi-specs/cspm/CloudAccounts(GCP).json +++ b/openapi-specs/cspm/CloudAccounts(GCP).json @@ -427,9 +427,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -487,9 +484,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "not_found / internal_error" } }, "security": [ @@ -532,9 +526,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -591,9 +582,6 @@ }, "404": { "description": "invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -697,9 +685,6 @@ }, "400": { "description": "bad_request / unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -796,9 +781,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -898,9 +880,6 @@ }, "400": { "description": "bad_request / unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -972,9 +951,6 @@ }, "404": { "description": "invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/CloudAccounts(OCIandAlibaba).json b/openapi-specs/cspm/CloudAccounts(OCIandAlibaba).json index 4e757a23a..477db1e9d 100644 --- a/openapi-specs/cspm/CloudAccounts(OCIandAlibaba).json +++ b/openapi-specs/cspm/CloudAccounts(OCIandAlibaba).json @@ -1751,9 +1751,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1830,9 +1827,6 @@ }, "404": { "description": "invalid_account_type" - }, - "500": { - "description": "not_found / internal_error" } }, "security": [ @@ -1896,9 +1890,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1931,9 +1922,6 @@ }, "400": { "description": "invalid_parameter_value" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/CloudAccountsMicroService.json b/openapi-specs/cspm/CloudAccountsMicroService.json index e055477cf..be17ad52f 100644 --- a/openapi-specs/cspm/CloudAccountsMicroService.json +++ b/openapi-specs/cspm/CloudAccountsMicroService.json @@ -108,16 +108,6 @@ } } }, - "500": { - "description": "Failed with an Exception, Internal Error Occurred", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - } - }, "401": { "description": "Unauthorized Access", "content": { @@ -280,16 +270,6 @@ } } }, - "500": { - "description": "Failed with an exception.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, "404": { "description": "Not Found", "content": { @@ -395,16 +375,6 @@ } } }, - "500": { - "description": "Failed with an exception.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, "404": { "description": "Not Found", "content": { @@ -523,16 +493,6 @@ } } }, - "500": { - "description": "Failed with an Exception, Internal Error Occurred", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, "425": { "description": "Too Early to access the resource", "content": { @@ -658,16 +618,6 @@ } } }, - "500": { - "description": "Failed with an exception.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, "404": { "description": "Not Found", "content": { @@ -907,16 +857,6 @@ } } }, - "500": { - "description": "Failed with an exception.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, "404": { "description": "Not Found", "content": { diff --git a/openapi-specs/cspm/CollectionsMicroservice.json b/openapi-specs/cspm/CollectionsMicroservice.json index 8159d8edd..34215c3e6 100644 --- a/openapi-specs/cspm/CollectionsMicroservice.json +++ b/openapi-specs/cspm/CollectionsMicroservice.json @@ -91,26 +91,6 @@ } ], "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -204,26 +184,6 @@ "required": true }, "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -307,26 +267,6 @@ } ], "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -432,26 +372,6 @@ } ], "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -556,26 +476,6 @@ "required": true }, "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "*/*": { - "schema": { - "type": "object" - } - } - } - }, "403": { "description": "Forbidden", "content": { diff --git a/openapi-specs/cspm/CommandCenterMicroService.json b/openapi-specs/cspm/CommandCenterMicroService.json index ba5662e4b..6ce2aec11 100644 --- a/openapi-specs/cspm/CommandCenterMicroService.json +++ b/openapi-specs/cspm/CommandCenterMicroService.json @@ -84,26 +84,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ @@ -179,26 +159,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ @@ -274,26 +234,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ @@ -374,26 +314,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ @@ -459,26 +379,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, "security": [ diff --git a/openapi-specs/cspm/CompliancePosture.json b/openapi-specs/cspm/CompliancePosture.json index 9059ae844..d3ff51df9 100644 --- a/openapi-specs/cspm/CompliancePosture.json +++ b/openapi-specs/cspm/CompliancePosture.json @@ -805,9 +805,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -846,9 +843,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -975,9 +969,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1028,9 +1019,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1158,9 +1146,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1221,9 +1206,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1352,9 +1334,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1396,9 +1375,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1528,9 +1504,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1584,9 +1557,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1717,9 +1687,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1783,9 +1750,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1813,9 +1777,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1853,9 +1814,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1942,9 +1900,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1982,9 +1937,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2072,9 +2024,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2124,9 +2073,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2215,9 +2161,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2277,9 +2220,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2369,9 +2309,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2412,9 +2349,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2505,9 +2439,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2560,9 +2491,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2654,9 +2582,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -2719,9 +2644,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/ComplianceStandards.json b/openapi-specs/cspm/ComplianceStandards.json index df1c813fd..fe331479e 100644 --- a/openapi-specs/cspm/ComplianceStandards.json +++ b/openapi-specs/cspm/ComplianceStandards.json @@ -306,9 +306,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -339,9 +336,6 @@ }, "400": { "description": "missing_required_parameter / duplicate_name / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -381,9 +375,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -426,9 +417,6 @@ }, "400": { "description": "missing_required_parameter / duplicate_name / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -462,9 +450,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -509,9 +494,6 @@ }, "400": { "description": "missing_required_parameter / duplicate_name / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -557,9 +539,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -602,9 +581,6 @@ }, "400": { "description": "missing_required_parameter / duplicate_name / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -647,9 +623,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -692,9 +665,6 @@ }, "400": { "description": "missing_required_parameter / duplicate_name / bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -728,9 +698,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -776,9 +743,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -821,9 +785,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -868,9 +829,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -904,9 +862,6 @@ }, "400": { "description": "missing_required_parameter" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/DataSecurityDashboard.json b/openapi-specs/cspm/DataSecurityDashboard.json index 9682b11f7..d4e6b2a92 100644 --- a/openapi-specs/cspm/DataSecurityDashboard.json +++ b/openapi-specs/cspm/DataSecurityDashboard.json @@ -438,9 +438,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -480,9 +477,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -522,9 +516,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -564,9 +555,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -603,9 +591,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -642,9 +627,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -684,9 +666,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/DataSecurityInventory.json b/openapi-specs/cspm/DataSecurityInventory.json index 5eb21436e..7fd09fd0a 100644 --- a/openapi-specs/cspm/DataSecurityInventory.json +++ b/openapi-specs/cspm/DataSecurityInventory.json @@ -1071,9 +1071,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1116,9 +1113,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1162,9 +1156,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1204,9 +1195,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1243,9 +1231,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1285,9 +1270,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1327,9 +1309,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1369,9 +1348,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1408,9 +1384,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1461,9 +1434,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1500,9 +1470,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1539,9 +1506,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1581,9 +1545,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1634,9 +1595,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/DataSecurityOnboardingMicroService.json b/openapi-specs/cspm/DataSecurityOnboardingMicroService.json index 33c37ea98..28b02d88b 100644 --- a/openapi-specs/cspm/DataSecurityOnboardingMicroService.json +++ b/openapi-specs/cspm/DataSecurityOnboardingMicroService.json @@ -81,9 +81,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -121,9 +118,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -195,9 +189,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -243,9 +234,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -291,9 +279,6 @@ "400": { "description": "bad_request" }, - "500": { - "description": "internal_error" - }, "401": { "description": "unauthenticated_access" }, @@ -371,9 +356,6 @@ "content": { "application/octet-stream": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -418,9 +400,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -458,9 +437,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -504,9 +480,6 @@ "content": { "application/json": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -559,9 +532,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -605,9 +575,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -645,9 +612,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -684,9 +648,6 @@ "content": { "application/json": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -731,9 +692,6 @@ "content": { "application/json": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -776,9 +734,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -823,9 +778,6 @@ "content": { "application/json": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -876,9 +828,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -922,9 +871,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -968,9 +914,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -1008,9 +951,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -1055,9 +995,6 @@ "application/json": {} } }, - "500": { - "description": "internal_error" - }, "400": { "description": "bad_request" } @@ -1097,9 +1034,6 @@ "400": { "description": "bad_request" }, - "500": { - "description": "internal_error" - }, "403": { "description": "unauthorized_access" } @@ -1139,9 +1073,6 @@ "400": { "description": "bad_request" }, - "500": { - "description": "internal_error" - }, "403": { "description": "unauthorized_access" }, @@ -1175,9 +1106,6 @@ "400": { "description": "bad_request" }, - "500": { - "description": "internal_error" - }, "403": { "description": "unauthorized_access" } @@ -1204,9 +1132,6 @@ "content": { "application/octet-stream": {} } - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -1244,9 +1169,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", @@ -1281,9 +1203,6 @@ "400": { "description": "bad_request" }, - "500": { - "description": "internal_error" - }, "403": { "description": "unauthorized_access" }, @@ -1334,9 +1253,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "x-public": "true", diff --git a/openapi-specs/cspm/DataSecuritySettings.json b/openapi-specs/cspm/DataSecuritySettings.json index cc88c88b1..41b2f6a22 100644 --- a/openapi-specs/cspm/DataSecuritySettings.json +++ b/openapi-specs/cspm/DataSecuritySettings.json @@ -1040,9 +1040,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1090,9 +1087,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1140,9 +1134,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1178,9 +1169,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1228,9 +1216,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1270,9 +1255,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1314,9 +1296,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1375,9 +1354,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1425,9 +1401,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1456,9 +1429,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1504,9 +1474,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1545,9 +1512,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1587,9 +1551,6 @@ } }, "description": "success" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1646,9 +1607,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1696,9 +1654,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1739,9 +1694,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1773,9 +1725,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1821,9 +1770,6 @@ } }, "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/EventBridgeMicroService.json b/openapi-specs/cspm/EventBridgeMicroService.json index ac1205a10..acd794b2b 100644 --- a/openapi-specs/cspm/EventBridgeMicroService.json +++ b/openapi-specs/cspm/EventBridgeMicroService.json @@ -82,18 +82,6 @@ } ], "responses": { - "500": { - "description": "Internal server error occurred", - "content": { - "*/*": { - "schema": { - "type": "object", - "example": null - }, - "example": null - } - } - }, "200": { "description": "OK", "content": { @@ -154,21 +142,6 @@ } ], "responses": { - "500": { - "description": "Internal server error occurred", - "content": { - "*/*": { - "schema": { - "type": "array", - "example": null, - "items": { - "$ref": "#/components/schemas/AuditLogsConfigStatusComponent" - } - }, - "example": null - } - } - }, "200": { "description": "OK", "content": { @@ -231,18 +204,6 @@ } ], "responses": { - "500": { - "description": "Internal server error occurred", - "content": { - "*/*": { - "schema": { - "type": "object", - "example": null - }, - "example": null - } - } - }, "401": { "description": "Unauthorized Access", "content": { @@ -305,18 +266,6 @@ } ], "responses": { - "500": { - "description": "Internal server error occurred", - "content": { - "*/*": { - "schema": { - "type": "object", - "example": null - }, - "example": null - } - } - }, "401": { "description": "Unauthorized Access", "content": { diff --git a/openapi-specs/cspm/IAMMicroService.json b/openapi-specs/cspm/IAMMicroService.json index c422a50d0..a0ccd5d6f 100644 --- a/openapi-specs/cspm/IAMMicroService.json +++ b/openapi-specs/cspm/IAMMicroService.json @@ -175,7 +175,7 @@ "tags": [ "IAM" ], - "summary": "Get Permissions Access", + "summary": "Get Permission Accesses", "description": "Given a permission ID and an \n[IAM query](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-rql-reference/rql-reference/iam-query.html),\nreturns data about the actual permission usage (last access).\n\n\nThe request parameter **limit** determines the number of items—that is, last access—in the response object. \n\n\nIf the amount of available data is greater than the \nspecified **limit**, use the response object attribute **data.nextPageToken** as the request parameter **pageToken** in \n[Get Permissions Access Next Page](/prisma-cloud/api/cspm/get-next-permissions-access-with-post) to request the\nnext page of data.\n", "operationId": "get-permissions-access-with-post", "requestBody": { diff --git a/openapi-specs/cspm/IAMV2MicroService.json b/openapi-specs/cspm/IAMV2MicroService.json new file mode 100644 index 000000000..66876e355 --- /dev/null +++ b/openapi-specs/cspm/IAMV2MicroService.json @@ -0,0 +1,2221 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "OpenAPI definition", + "version": "v0" + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ], + "paths": { + "/iam/api/v3/search/permission": { + "post": { + "tags": [ + "IAM" + ], + "summary": "Get Permissions V3", + "description": "Returns a page of permissions and a page token for the next page if applicable", + "operationId": "search-permissions-v3", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Query records limit", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 5 + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionSearchRequestDtoV3" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionSearchResponseDtoV3" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v3/permission/{permission-id}/list_access": { + "post": { + "tags": [ + "IAM" + ], + "summary": "Get Permission Accesses V3", + "description": "Returns a page of permission's last acceses and a page token for the next page if applicable", + "operationId": "permissions-accesses-v3", + "parameters": [ + { + "name": "permission-id", + "in": "path", + "description": "The permission id. Can be retrieved from search/permission api", + "required": true, + "schema": { + "type": "string", + "description": "The permission id. Can be retrieved from search/permission api", + "example": "06c3cb4403ac276ff59679139b8e6afca2afe93100c8b39014f033ca0339ff0f" + }, + "example": "06c3cb4403ac276ff59679139b8e6afca2afe93100c8b39014f033ca0339ff0f" + }, + { + "name": "limit", + "in": "query", + "description": "Query records limit", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 5 + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionAccessRequestDtoV3" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionAccessResponseDtoV3" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v2/suggestion": { + "post": { + "tags": [ + "IAM" + ], + "summary": "Get Query Suggestions V2", + "description": "Suggest auto completion for RQL and notify whether the current RQL is valid or not", + "operationId": "iam-suggest-v2", + "parameters": [ + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuggestRequestDto" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuggestResponseDto" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v2/search/iam_config": { + "post": { + "tags": [ + "IAM" + ], + "summary": "Get Permissions Role or Policy Definition V2", + "description": "Returns the raw config (policy/role definition) which the permission was calculated from", + "operationId": "permission-raw-config-definition", + "parameters": [ + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionRawDataRequestDto" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionRawDataResponseDto" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v1/asset/{asset-id}/related-asset": { + "post": { + "tags": [ + "IAM" + ], + "summary": "Get Cloud Identity Inventory (CII) Resource Related Assets", + "description": "Get assets related to Cloud Identity Inventory (CII) resource.", + "operationId": "cii-related-assets-v1", + "parameters": [ + { + "name": "asset-id", + "in": "path", + "description": "The asset UAI where you want to find it related assets", + "required": true, + "schema": { + "type": "string", + "description": "The asset UAI where you want to find it related assets", + "example": "681390424b288d835f5cd03e7bfb0993" + }, + "example": "681390424b288d835f5cd03e7bfb0993" + }, + { + "name": "limit", + "in": "query", + "description": "Query client records limit, return MAX(0, MIN(client.limit, service.limit))", + "required": false, + "schema": { + "type": "string", + "description": "Query client records limit, return MAX(0, MIN(client.limit, service.limit))", + "example": 5 + }, + "example": 5 + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloudAssetRelatedAssetsRequestDto" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloudAssetRelatedAssetsResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v2/alert/{alertId}/remediation_command": { + "get": { + "tags": [ + "IAM" + ], + "summary": "Get Remediation Command", + "description": "Get remediation command for an alert", + "operationId": "alert-remediation-command", + "parameters": [ + { + "name": "alertId", + "in": "path", + "description": "The alert id", + "required": true, + "schema": { + "type": "string", + "description": "The alert id", + "example": "I-34537" + }, + "example": "I-34537" + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemediationResponseDtoV2" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v2/alert/{alertId}/query": { + "get": { + "tags": [ + "IAM" + ], + "summary": "Get IAM Query V2", + "description": "Returns the query associated with an alert instance", + "operationId": "investigate-alert", + "parameters": [ + { + "name": "alertId", + "in": "path", + "description": "The alert id", + "required": true, + "schema": { + "type": "string", + "description": "The alert id", + "example": "I-34537" + }, + "example": "I-34537" + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RqlResponseDtoV2" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v1/assets/{assetId}/over-permissive-metadata": { + "get": { + "tags": [ + "IAM" + ], + "summary": "Get Least Privilege Access Metadata of an Asset", + "description": "Return a metadata and info about the improvement potential for an assert of Least Privilege Access.", + "operationId": "least-privilege-access-metadata-v1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "description": "the UAI asset Id", + "required": true, + "schema": { + "type": "string", + "description": "the UAI asset Id", + "example": "681390424b288d835f5cd03e7bfb0993" + }, + "example": "681390424b288d835f5cd03e7bfb0993" + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OverPermissiveMetadataResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v1/assets/{assetId}/existing-least-privileged-access": { + "get": { + "tags": [ + "IAM" + ], + "summary": "Get Existing Least Privilege Access Suggestions for an Asset", + "description": "Suggest least privileged access from existing resources according to the asset. This configuration will minimize the amount of policies/roles used while preserve all the actions used in the last specified last X days", + "operationId": "existing-least-privilege-access-v1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "description": "the UAI asset Id", + "required": true, + "schema": { + "type": "string", + "description": "the UAI asset Id", + "example": "681390424b288d835f5cd03e7bfb0993" + }, + "example": "681390424b288d835f5cd03e7bfb0993" + }, + { + "name": "output_format", + "in": "query", + "description": "Output format type. One of: JSON / TERRAFORM/ CF", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": "JSON" + }, + { + "name": "lookback_duration_days", + "in": "query", + "description": "Amount of days to look back for used actions", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 90 + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExistingLeastPrivilegedAccessResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/iam/api/v1/assets/{assetId}/custom-least-privileged-access": { + "get": { + "tags": [ + "IAM" + ], + "summary": "Get New Least Privilege Access Suggestions for an Asset", + "description": "Generate Custom least privileged access configuration for the asset. Applying this configuration will minimize the amount of policies/roles used while preserve all the actions used in the last specified last X days", + "operationId": "custom-least-privilege-access-v1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "description": "the UAI asset Id", + "required": true, + "schema": { + "type": "string", + "description": "the UAI asset Id", + "example": "681390424b288d835f5cd03e7bfb0993" + }, + "example": "681390424b288d835f5cd03e7bfb0993" + }, + { + "name": "output_format", + "in": "query", + "description": "Output format type. One of: JSON / TERRAFORM/ CF", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": "JSON" + }, + { + "name": "lookback_duration_days", + "in": "query", + "description": "Amount of days to look back for used actions", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 90 + }, + { + "name": "x-redlock-auth", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "429": { + "description": "Throttled", + "headers": { + "X-RateLimit-Remaining": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Requested-Tokens": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Burst-Capacity": { + "style": "simple", + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Replenish-Rate": { + "style": "simple", + "schema": { + "type": "integer" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomLeastPrivilegedAccessResponseDto" + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + } + } + }, + "x-microservice": "true", + "x-public": "true", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + } + }, + "components": { + "schemas": { + "ApiErrorResponseBodyDto": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "string" + } + }, + "innerError": { + "$ref": "#/components/schemas/ApiErrorResponseDto" + } + } + }, + "ApiErrorResponseDto": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/ApiErrorResponseBodyDto" + } + } + }, + "PermissionSearchRequestDtoV3": { + "required": [ + "query" + ], + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "RQL query", + "example": "config from iam where source.cloud.type = 'AWS'" + }, + "id": { + "type": "string", + "description": "An optional saved search id. If not provided, a new saved search will be created.", + "example": "445f6ec2-0a47-4d60-a80c-b0c47e5616f1" + }, + "nextPageToken": { + "type": "string", + "description": "Page Token", + "example": "++fdfkjsdlfsdfdFDSFDFSDFdfdssfdFDS" + } + } + }, + "PermissionDto": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Message id", + "example": "13" + }, + "sourcePublic": { + "type": "boolean", + "description": "Is source public", + "example": false + }, + "sourceCloudType": { + "type": "string", + "description": "Source cloud type", + "example": "AWS" + }, + "sourceCloudAccount": { + "type": "string", + "description": "Source cloud account", + "example": "123456789" + }, + "sourceCloudRegion": { + "type": "string", + "description": "Source cloud region", + "example": "AWS London" + }, + "sourceCloudServiceName": { + "type": "string", + "description": "Source cloud service name", + "example": "iam" + }, + "sourceResourceName": { + "type": "string", + "description": "Source cloud resource name", + "example": "john" + }, + "sourceResourceType": { + "type": "string", + "description": "Source cloud resource type", + "example": "user" + }, + "sourceResourceId": { + "type": "string", + "description": "Source cloud resource id", + "example": "arn:aws:iam::111111:user/john" + }, + "sourceIdpService": { + "type": "string", + "description": "Source IDP service" + }, + "sourceIdpDomain": { + "type": "string", + "description": "Source IDP domain" + }, + "sourceIdpEmail": { + "type": "string", + "description": "Source IDP email" + }, + "sourceIdpUsername": { + "type": "string", + "description": "Source IDP user name" + }, + "sourceIdpGroup": { + "type": "string", + "description": "Source IDP group" + }, + "sourceIdpRrn": { + "type": "string", + "description": "Source idp RRN", + "example": "rrn::other::idp-account-id::idp-user-id" + }, + "sourceIdpUai": { + "type": "string", + "description": "Source idp UAI", + "example": "681390424b288d835f5cd03e7bfb0993" + }, + "sourceCloudResourceRrn": { + "type": "string", + "description": "Source cloud resource RRN", + "example": "rrn::iamUser::123456789012::AIDAIDAIDAIDAIDAIDAID" + }, + "sourceCloudResourceUai": { + "type": "string", + "description": "Source cloud resource UAI", + "example": "681390624b288d835f4cd03e7bfb0994" + }, + "destCloudType": { + "type": "string", + "description": "Destination cloud type", + "example": "AWS" + }, + "destCloudAccount": { + "type": "string", + "description": "Destination cloud account", + "example": "123456789" + }, + "destCloudRegion": { + "type": "string", + "description": "Destination cloud region", + "example": "AWS London" + }, + "destCloudServiceName": { + "type": "string", + "description": "Destination cloud service name", + "example": "iam" + }, + "destResourceName": { + "type": "string", + "description": "Destination cloud resource name", + "example": "john" + }, + "destResourceType": { + "type": "string", + "description": "Destination cloud resource type", + "example": "user" + }, + "destResourceId": { + "type": "string", + "description": "Destination cloud resource id", + "example": "arn:aws:iam::111111:user/john" + }, + "destCloudResourceRrn": { + "type": "string", + "description": "Destination cloud resource RRN", + "example": "rrn::other:eu-west-2:123456789012::my-function" + }, + "destCloudResourceUai": { + "type": "string", + "description": "Destination cloud resource UAI", + "example": "181390424b298d835f4cd03e7bfb0991" + }, + "effectiveActionName": { + "type": "string", + "description": "Effective action name" + }, + "grantedByCloudType": { + "type": "string", + "description": "Granted by cloud type", + "example": "AWS" + }, + "grantedByCloudPolicyId": { + "type": "string", + "description": "Granted by cloud policy Id", + "example": "arn:aws:iam::aws:policy/aws-policy" + }, + "grantedByCloudPolicyName": { + "type": "string", + "description": "Granted by cloud policy name", + "example": "my-policy" + }, + "grantedByCloudPolicyType": { + "type": "string", + "description": "Granted by cloud policy type", + "example": "Customer Managed Policy" + }, + "grantedByCloudPolicyRrn": { + "type": "string", + "description": "Granted by cloud policy rrn", + "example": "rrn::iamPolicy::123456789012::arn:aws:iam:eu-west-2" + }, + "grantedByCloudPolicyUai": { + "type": "string", + "description": "Granted by cloud policy UAI", + "example": "771390424b298d835f4cd03e7bfb0232" + }, + "grantedByCloudEntityId": { + "type": "string", + "description": "Granted by cloud entity id", + "example": "arn:aws:iam:::role/my-role" + }, + "grantedByCloudEntityName": { + "type": "string", + "description": "Granted by cloud entity name", + "example": "my-role" + }, + "grantedByCloudEntityType": { + "type": "string", + "description": "Granted by cloud entity type", + "example": "user" + }, + "accessedResourcesCount": { + "type": "integer", + "description": "Accessed resource count", + "format": "int64" + }, + "lastAccessDate": { + "type": "string", + "description": "Last accessed data" + }, + "lastAccessStatus": { + "type": "string", + "description": "Last accessed status" + }, + "grantedByCloudEntityRrn": { + "type": "string", + "description": "Granted by cloud entity rrn", + "example": "rrn::other::123456789:AIDAIDAIDAIDAIDAIDAID" + }, + "grantedByCloudEntityUai": { + "type": "string", + "description": "Granted by cloud entity UAI", + "example": "223390424b298d835f4cd03e7bfb0111" + }, + "isWildCardDestCloudResourceName": { + "type": "boolean", + "description": "Is destination cloud resource name a wildcard", + "example": false + }, + "exceptions": { + "type": "array", + "description": "Permission exception list", + "items": { + "$ref": "#/components/schemas/PermissionExceptionDto" + } + }, + "grantedByLevelType": { + "type": "string", + "description": "Granted by level type", + "example": "GCP Folder" + }, + "grantedByLevelId": { + "type": "string", + "description": "Granted by level id", + "example": "level_id" + }, + "grantedByLevelName": { + "type": "string", + "description": "Granted by level name", + "example": "level_name" + }, + "grantedByLevelRrn": { + "type": "string", + "description": "Granted by level rrn", + "example": "level_rrn" + }, + "grantedByLevelUai": { + "type": "string", + "description": "Granted by level UAI", + "example": "123390424cb99d835f4cd03e7bfb0991" + } + }, + "description": "items list" + }, + "PermissionExceptionDto": { + "type": "object", + "properties": { + "messageCode": { + "type": "string", + "description": "Message code", + "example": "LIMITED_BY_DENY_STATEMENT" + } + }, + "description": "Permission exception list" + }, + "PermissionSearchResponseDtoV3": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PermissionSearchResultDataDtoV3" + }, + "query": { + "type": "string", + "description": "Query string", + "example": "config from iam where ..." + }, + "id": { + "type": "string", + "description": "Request user Id", + "example": "111111" + }, + "saved": { + "type": "boolean", + "description": "Is search saved", + "example": true + }, + "name": { + "type": "string", + "description": "Search name", + "example": "search-name" + }, + "timeRange": { + "$ref": "#/components/schemas/TimeRangeDto" + }, + "searchType": { + "type": "string", + "description": "Search type", + "example": "search-type" + }, + "description": { + "type": "string", + "description": "Search description", + "example": "search-description" + }, + "cloudType": { + "type": "string", + "description": "Cloud Type", + "example": "aws" + } + } + }, + "PermissionSearchResultDataDtoV3": { + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "items list", + "items": { + "$ref": "#/components/schemas/PermissionDto" + } + }, + "nextPageToken": { + "type": "string", + "description": "Next page token", + "example": "iam/api/{apiVersion}/{apiPath}?page-token=Q74589g444gg" + }, + "totalRows": { + "type": "integer", + "description": "Total rows count", + "format": "int64", + "example": 1243 + }, + "searchedDestCloudResourceNames": { + "uniqueItems": true, + "type": "array", + "description": "Searched destination cloud resource names", + "example": [], + "items": { + "type": "string", + "description": "Searched destination cloud resource names", + "example": "[]" + } + } + } + }, + "TimeRangeDto": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "description": "The time range which the query run at to generate the alert", + "example": "{''type': 'relative', 'value': {'unit': 'day', 'amount': 7} }", + "discriminator": { + "propertyName": "type" + } + }, + "PermissionAccessRequestDtoV3": { + "required": [ + "query" + ], + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "Query string", + "example": "config from iam where source.cloud.type = 'AWS'" + }, + "nextPageToken": { + "type": "string", + "description": "Page Token", + "example": "++fdfkjsdlfsdfdFDSFDFSDFdfdssfdFDS" + } + } + }, + "PermissionAccessResponseDtoV3": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PermissionAccessResultDataDtoV3" + } + } + }, + "PermissionAccessResultDataDtoV3": { + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "items list", + "items": { + "$ref": "#/components/schemas/PermissionLastAccessDto" + } + }, + "nextPageToken": { + "type": "string", + "description": "Next page token", + "example": "iam/api/{apiVersion}/{apiPath}?page-token=Q74589g444gg" + }, + "totalRows": { + "type": "integer", + "description": "Total rows count", + "format": "int64", + "example": 1243 + } + }, + "description": "Permissions last access list", + "readOnly": true + }, + "PermissionLastAccessDto": { + "type": "object", + "properties": { + "destCloudResourceName": { + "type": "string", + "description": "Destination cloud resource name", + "example": "my-function" + }, + "lastAccessDate": { + "type": "string", + "description": "Action last access date in the format of a unix timestamp", + "example": "1593691785" + }, + "destCloudRegion": { + "type": "string", + "description": "Action last access region", + "example": "AWS Virginia" + }, + "destCloudAccount": { + "type": "string", + "description": "Action last access account name", + "example": "account_name" + } + }, + "description": "items list" + }, + "SuggestRequestDto": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "Query to validate", + "example": "config from iam where dest.cloud.type = 'AWS'" + } + } + }, + "SuggestResponseDto": { + "type": "object", + "properties": { + "valid": { + "type": "boolean", + "description": "Is query valid", + "readOnly": true, + "example": true + }, + "suggestions": { + "uniqueItems": true, + "type": "array", + "description": "Suggestion list", + "readOnly": true, + "example": [ + "AND" + ], + "items": { + "type": "string", + "description": "Suggestion list", + "readOnly": true, + "example": "[\"AND\"]" + } + }, + "translate": { + "type": "boolean", + "description": "Should translate", + "readOnly": true, + "example": false + }, + "needsOffsetUpdate": { + "type": "boolean", + "description": "Should add offset from the query beginning", + "readOnly": true, + "example": true + }, + "offset": { + "type": "integer", + "description": "The number of characters of offset from the query beginning", + "format": "int32", + "readOnly": true, + "example": 43 + } + } + }, + "PermissionRawDataRequestDto": { + "type": "object", + "properties": { + "permissionId": { + "type": "string", + "description": "PermissionId to get the raw config for. Can be obtain form calling search/permission API", + "example": "06c3cb4403ac276ff59679139b8e6afca2afe93100c8b39014f033ca0339ff0f" + } + } + }, + "PermissionRawDataResponseDto": { + "type": "object", + "properties": { + "raw": { + "type": "string", + "description": "raw iam config (rolw/policy) which the permission was calculated from" + } + } + }, + "CloudAssetRelatedAssetsRequestDto": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Relationship Type", + "example": "aws_policy_role", + "enum": [ + "AWS_ROLE_POLICY", + "AWS_ROLE_TRUSTED", + "AWS_GROUP_USER", + "AWS_GROUP_POLICY", + "AWS_POLICY_GROUP", + "AWS_POLICY_ROLE", + "AWS_POLICY_RESOURCE", + "AWS_EC2_ROLE", + "AZURE_USERASSIGNED_SERVICEAPP", + "AZURE_USERASSIGNED_ROLEDEFINITION", + "AZURE_ROLEDEFINITION_USERASSIGNED", + "AZURE_ROLEDEFINITION_USER", + "AZURE_GROUP_MEMBERS", + "AZURE_GROUP_ROLEDEFINITION", + "AZURE_ROLEDEFINITION_GROUP", + "AZURE_SERVICEPRINCIPAL_APPREGISTRATION", + "AZURE_SERVICEPRINCIPAL_ROLEDEFINITION", + "AZURE_ROLEDEFINITION_SERVICEPRINCIPAL" + ] + }, + "lastAccessFromTime": { + "type": "integer", + "description": "Last accessed From epoch (epoch)", + "format": "int64", + "example": 1678785157 + }, + "lastAccessToTime": { + "type": "integer", + "description": "Last accessed To epoch (epoch)", + "format": "int64", + "example": 1678785157 + }, + "nextPageToken": { + "type": "string", + "description": "Page Token", + "example": "++fdfkjsdlfsdfdFDSFDFSDFdfdssfdFDS" + } + } + }, + "CloudAssetRelatedAssetDto": { + "type": "object", + "properties": { + "targetAssetId": { + "type": "string", + "description": "Target Asset Id (unifiedAssetId)", + "example": "1593691785" + }, + "targetCloudResourceId": { + "type": "string", + "description": "Target Asset Cloud Resource Id", + "example": "1593691785" + }, + "targetDisplayName": { + "type": "string", + "description": "Target DisplayName" + }, + "targetResourceType": { + "type": "string", + "description": "Target resource type" + }, + "lastAccessDate": { + "type": "string", + "description": "Action last access date in the format of a unix timestamp", + "example": "1593691785" + }, + "lastAccessStatus": { + "type": "string", + "description": "Last accessed status" + }, + "grantedByLevelType": { + "type": "string", + "description": "Granted by level type" + } + }, + "description": "items list" + }, + "CloudAssetRelatedAssetsResponseDto": { + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "items list", + "items": { + "$ref": "#/components/schemas/CloudAssetRelatedAssetDto" + } + }, + "nextPageToken": { + "type": "string", + "description": "Next page token", + "example": "iam/api/{apiVersion}/{apiPath}?page-token=Q74589g444gg" + }, + "totalRows": { + "type": "integer", + "description": "Total rows count", + "format": "int64", + "example": 1243 + } + } + }, + "RemediationResponseDtoV2": { + "type": "object", + "properties": { + "cliCommand": { + "type": "string", + "description": "Relevant cli command for remediation", + "example": "cli command" + }, + "cliDescription": { + "type": "string", + "description": "Cli Description", + "example": "The following are CLI command is required for remediation. Successful execution will limit the relevant permissions of the violating resource." + } + } + }, + "RqlResponseDtoV2": { + "type": "object", + "properties": { + "timeRange": { + "$ref": "#/components/schemas/TimeRangeDto" + }, + "query": { + "type": "string", + "example": "config from iam where source.cloud.type = 'AWS'" + } + } + }, + "OverPermissiveMetadataResponseDto": { + "type": "object", + "properties": { + "totalIamResourceCount": { + "type": "integer", + "description": "The total number of iam resources attached to the asset", + "format": "int32", + "example": 15 + }, + "overPermissiveCount": { + "type": "integer", + "description": "The number of over permissive iam resources attached to the asset", + "format": "int32", + "example": 10 + }, + "isCustomLeastPrivilegedSupported": { + "type": "boolean", + "description": "Is custom least privileged access supported for asset", + "example": true + }, + "isExistingLeastPrivilegedSupported": { + "type": "boolean", + "description": "Is existing least privileged access supported for asset", + "example": true + }, + "iamResourceType": { + "type": "string", + "description": "The type of resources attached to the asset", + "example": "AWS IAM Policy" + } + } + }, + "ExistingLeastPrivilegedAccessDto": { + "type": "object", + "properties": { + "iamResourceName": { + "type": "string", + "description": "The name of the iam resource", + "example": "MyIamResource" + }, + "iamResourceId": { + "type": "string", + "description": "The id of the iam resource", + "example": "rrn:aws:iamRole::123456789012:3fab987adf7c268519219cdfe5a4c4c2d4dc:AROAXHNDH53GWC2HSVKSR" + }, + "iamResourceType": { + "type": "string", + "description": "The type of iam resource", + "example": "AWS_POLICY" + }, + "formatType": { + "type": "string", + "description": "Format type of the access policy", + "example": "TERRAFORM" + }, + "snippet": { + "type": "string", + "description": "The access policy", + "example": "A Terraform code for creating a policy" + } + }, + "description": "Least Privileged Access items" + }, + "ExistingLeastPrivilegedAccessResponseDto": { + "type": "object", + "properties": { + "nextPageToken": { + "type": "string", + "description": "Next page token", + "example": "++fdfkjsdlfsdfdFDSFDFSDFdfdssfdFDS" + }, + "permissionsInAssetCount": { + "type": "integer", + "description": "Number of actions in asset", + "format": "int32", + "example": 10 + }, + "permissionsInLeastPrivilegedCount": { + "type": "integer", + "description": "Number of actions in least privileged access", + "format": "int32", + "example": 10 + }, + "analysis": { + "type": "array", + "description": "Least Privileged result analysis", + "items": { + "$ref": "#/components/schemas/LeastPrivilegedPermissionVerdict" + } + }, + "value": { + "type": "array", + "description": "Least Privileged Access items", + "items": { + "$ref": "#/components/schemas/ExistingLeastPrivilegedAccessDto" + } + } + } + }, + "LeastPrivilegedPermissionVerdict": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "configurationName": { + "type": "string" + }, + "keep": { + "type": "boolean" + } + }, + "description": "Least Privileged result analysis" + }, + "CustomLeastPrivilegedAccessDto": { + "type": "object", + "properties": { + "formatType": { + "type": "string", + "description": "Format type of the access policy", + "example": "TERRAFORM" + }, + "snippet": { + "type": "string", + "description": "The access policy", + "example": "Terraform code for creating a policy" + } + }, + "description": "Least Privileged Access items" + }, + "CustomLeastPrivilegedAccessResponseDto": { + "type": "object", + "properties": { + "nextPageToken": { + "type": "string", + "description": "Next page token", + "example": "++fdfkjsdlfsdfdFDSFDFSDFdfdssfdFDS" + }, + "permissionsInAssetCount": { + "type": "integer", + "description": "Number of actions in asset", + "format": "int32", + "example": 10 + }, + "permissionsInLeastPrivilegedCount": { + "type": "integer", + "description": "Number of actions in least privileged access", + "format": "int32", + "example": 10 + }, + "analysis": { + "type": "array", + "description": "Least Privileged result analysis", + "items": { + "$ref": "#/components/schemas/LeastPrivilegedPermissionVerdict" + } + }, + "value": { + "type": "array", + "description": "Least Privileged Access items", + "items": { + "$ref": "#/components/schemas/CustomLeastPrivilegedAccessDto" + } + } + } + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + } +} diff --git a/openapi-specs/cspm/IPAllowList.json b/openapi-specs/cspm/IPAllowList.json index cbcee0f37..1d6e010bf 100644 --- a/openapi-specs/cspm/IPAllowList.json +++ b/openapi-specs/cspm/IPAllowList.json @@ -496,9 +496,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -544,9 +541,6 @@ }, "409": { "description": "login_ip_allow_list_duplicate_key" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -591,9 +585,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -653,9 +644,6 @@ }, "409": { "description": "login_ip_allow_list_duplicate_name" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -694,9 +682,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -727,9 +712,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -771,9 +753,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/IntegrationsMicroService.json b/openapi-specs/cspm/IntegrationsMicroService.json index e37b53021..4555c781f 100644 --- a/openapi-specs/cspm/IntegrationsMicroService.json +++ b/openapi-specs/cspm/IntegrationsMicroService.json @@ -422,9 +422,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -509,9 +506,6 @@ "429": { "description": "Too many requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -571,9 +565,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -634,9 +625,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -698,9 +686,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -768,9 +753,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -822,9 +804,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -888,9 +867,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -951,9 +927,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -1011,9 +984,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { diff --git a/openapi-specs/cspm/LicensingMicroService.json b/openapi-specs/cspm/LicensingMicroService.json index 2f8aacbeb..a494eab72 100644 --- a/openapi-specs/cspm/LicensingMicroService.json +++ b/openapi-specs/cspm/LicensingMicroService.json @@ -99,16 +99,6 @@ } } }, - "500": { - "description": "internal_error", - "content": { - "application/json;charset=UTF-8": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -167,16 +157,6 @@ } } }, - "500": { - "description": "internal_error", - "content": { - "application/json;charset=UTF-8": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -262,28 +242,6 @@ } } }, - "500": { - "description": "internal_error", - "content": { - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - }, - "application/json;charset=UTF-8": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/LicenseResponseModel" - }, - { - "$ref": "#/components/schemas/SpringErrorResponse" - } - ] - } - } - } - }, "403": { "description": "Forbidden", "content": { @@ -354,16 +312,6 @@ } } }, - "500": { - "description": "internal_error", - "content": { - "application/json;charset=UTF-8": { - "schema": { - "$ref": "#/components/schemas/SpringErrorResponse" - } - } - } - }, "403": { "description": "Forbidden", "content": { diff --git a/openapi-specs/cspm/Login.json b/openapi-specs/cspm/Login.json index 3684d60da..456abe8d1 100644 --- a/openapi-specs/cspm/Login.json +++ b/openapi-specs/cspm/Login.json @@ -127,9 +127,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "login_failed_unknown_error" } }, "summary": "Login", @@ -155,9 +152,6 @@ }, "401": { "description": "token_expired" - }, - "500": { - "description": "login_failed_unknown_error" } }, "security": [ diff --git a/openapi-specs/cspm/NotificationTemplatesMicroService.json b/openapi-specs/cspm/NotificationTemplatesMicroService.json index ab1311f92..c8143f1fc 100644 --- a/openapi-specs/cspm/NotificationTemplatesMicroService.json +++ b/openapi-specs/cspm/NotificationTemplatesMicroService.json @@ -398,9 +398,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -460,9 +457,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -523,9 +517,6 @@ "429": { "description": "Too many requests" }, - "500": { - "description": "Internal server error" - }, "4XX": { "content": { "application/json": { @@ -587,9 +578,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -641,9 +629,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { @@ -707,9 +692,6 @@ "429": { "description": "Too Many Requests" }, - "500": { - "description": "Internal Server Error" - }, "4XX": { "content": { "application/json": { diff --git a/openapi-specs/cspm/OnboardingAWSS3FlowLogs.json b/openapi-specs/cspm/OnboardingAWSS3FlowLogs.json index 67a2c01e0..ce86f48e3 100644 --- a/openapi-specs/cspm/OnboardingAWSS3FlowLogs.json +++ b/openapi-specs/cspm/OnboardingAWSS3FlowLogs.json @@ -129,9 +129,6 @@ }, "404": { "description": "account_not_exist_or_disabled / AWS Flow Logs S3 feature not configured" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -189,9 +186,6 @@ }, "404": { "description": "account_not_exist_or_disabled / logging_account_not_exists" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -258,9 +252,6 @@ }, "404": { "description": "invalid_account_id_format" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -324,7 +315,7 @@ ], "tags": [ { - "description": "AWS Eventbridge API lets you access Eventbridge configuration for a given account.\n\n You can use the AWS S3 Flow Logs API for AWS S3 onboarding for organization and standalone accounts on all supported stacks.\n", + "description": "You can use the AWS S3 Flow Logs API for AWS S3 onboarding for organization \nand standalone accounts on all supported stacks.\n", "name": "Cloud Ingested Logs" } ] diff --git a/openapi-specs/cspm/Policy.json b/openapi-specs/cspm/Policy.json index 951841fd1..6fa33f898 100644 --- a/openapi-specs/cspm/Policy.json +++ b/openapi-specs/cspm/Policy.json @@ -1294,9 +1294,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1336,9 +1333,6 @@ }, "400": { "description": "missing_required_parameter / invalid_parameter_value / bad_requestmissing_required_parameter / duplicate_name / invalid_search_cloud_type_for_policy / create_update_disallowed_for_json_schema_type_policy / invalid_ruleremediation_allowed_only_for_config_policies / policy_remediation_disallowed_for_non_sys_admins / unauthorized_access / unable_to_determine_sub_types" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1544,9 +1538,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1594,9 +1585,6 @@ }, "404": { "description": "no_results" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1653,9 +1641,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1694,9 +1679,6 @@ }, "404": { "description": "no_results" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1746,9 +1728,6 @@ }, "404": { "description": "not_found / failed_update_policy_status" - }, - "500": { - "description": "failed_update_policy_status" } }, "security": [ @@ -1817,9 +1796,6 @@ }, "400": { "description": "missing_required_parameter / saved_search_validation_not_supported / preprocessor_not_allowed_for_policy / invalid_search_type_for_policy / invalid_search_type_for_policy / insufficient_query_for_policy_creation /invalid_hostfinding_type_redlock_in_search_query / invalid_search_cloud_type_for_policy / invalid_azure_resource_group_in_search_query / json_not_supported_in_event_query / anomaly_search_not_supported_in_event_query / rql_validation_service_unavailable / invalid_json_rule" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/Reports.json b/openapi-specs/cspm/Reports.json index 129715851..b0519a827 100644 --- a/openapi-specs/cspm/Reports.json +++ b/openapi-specs/cspm/Reports.json @@ -1172,9 +1172,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1437,9 +1434,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -1480,9 +1474,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/ResourceExplorer.json b/openapi-specs/cspm/ResourceExplorer.json index d88519830..e27babbd7 100644 --- a/openapi-specs/cspm/ResourceExplorer.json +++ b/openapi-specs/cspm/ResourceExplorer.json @@ -656,9 +656,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -896,9 +893,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -942,9 +936,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/ResourceLists.json b/openapi-specs/cspm/ResourceLists.json index 1464d8303..849af0048 100644 --- a/openapi-specs/cspm/ResourceLists.json +++ b/openapi-specs/cspm/ResourceLists.json @@ -148,9 +148,6 @@ }, "409": { "description": "duplicate_resource_list_name" - }, - "500": { - "description": "failed_to_parse_resource_lists" } }, "security": [ @@ -280,9 +277,6 @@ }, "409": { "description": "duplicate_resource_list_name" - }, - "500": { - "description": "failed_to_parse_resource_lists" } }, "security": [ diff --git a/openapi-specs/cspm/SearchManager.json b/openapi-specs/cspm/SearchManager.json index f2677d6c1..afd3a025a 100644 --- a/openapi-specs/cspm/SearchManager.json +++ b/openapi-specs/cspm/SearchManager.json @@ -501,9 +501,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -542,9 +539,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -600,9 +594,6 @@ }, "404": { "description": "not_found" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -644,9 +635,6 @@ }, "409": { "description": "conflict_saved_search" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/SearchMicroService.json b/openapi-specs/cspm/SearchMicroService.json index 79359bcb3..a88e15eae 100644 --- a/openapi-specs/cspm/SearchMicroService.json +++ b/openapi-specs/cspm/SearchMicroService.json @@ -100,10 +100,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -149,10 +145,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -201,10 +193,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -258,10 +246,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -322,10 +306,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -375,10 +355,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -428,10 +404,6 @@ "400": { "description": "invalid_parameter_value", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -479,10 +451,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -523,10 +491,6 @@ } } } - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -576,10 +540,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -750,10 +710,6 @@ } } } - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ @@ -800,10 +756,6 @@ "404": { "description": "not_found", "content": {} - }, - "500": { - "description": "internal_error", - "content": {} } }, "security": [ diff --git a/openapi-specs/cspm/Settings.json b/openapi-specs/cspm/Settings.json index 5073b2d7f..f0473b934 100644 --- a/openapi-specs/cspm/Settings.json +++ b/openapi-specs/cspm/Settings.json @@ -110,9 +110,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -143,9 +140,6 @@ }, "400": { "description": "bad_request" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/System.json b/openapi-specs/cspm/System.json index cdd74ecee..bd3c6102a 100644 --- a/openapi-specs/cspm/System.json +++ b/openapi-specs/cspm/System.json @@ -43,9 +43,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "" } }, "summary": "Health Check", diff --git a/openapi-specs/cspm/UVEDashboardMicroService.json b/openapi-specs/cspm/UVEDashboardMicroService.json new file mode 100644 index 000000000..1b610175f --- /dev/null +++ b/openapi-specs/cspm/UVEDashboardMicroService.json @@ -0,0 +1,1076 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Vulnerability Dashboard API", + "description": "API for displaying Vulnerability Dashboard", + "version": "1.0.0" + }, + "tags": [ + { + "name": "Unified Vulnerability Explorer", + "description": "API for displaying Vulnerability Dashboard" + } + ], + "paths": { + "/uve/api/v1/dashboard/vulnerabilities/overview": { + "get": { + "summary": "Get Vulnerability Overview", + "description": "Returns a summary of the total vulnerabilities in your environment which is further divided into Vulnerabilities by Asset and Vulnerabilities that have already been remediated.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "vulnerability-dashboard-overview", + "parameters": [ + { + "name": "asset_type", + "in": "query", + "required": true, + "description": "Type of Asset", + "schema": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ] + } + }, + { + "name": "life_cycle", + "in": "query", + "description": "Life Cycle stage", + "required": true, + "schema": { + "type": "string", + "enum": [ + "code", + "build", + "deploy", + "run" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OverviewWidget" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/dashboard/vulnerabilities/prioritised": { + "get": { + "summary": "Get Prioritized Vulnerabilities", + "description": "Returns the top-priority vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "prioritised-vulnerability", + "parameters": [ + { + "name": "asset_type", + "description": "Type of Asset", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ] + } + }, + { + "name": "life_cycle", + "description": "Life Cycle stage", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "code", + "build", + "deploy", + "run" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PrioritizedVulnerabilities" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/dashboard/vulnerabilities/impact-stage": { + "get": { + "summary": "Get Vulnerability Impact by Stage", + "description": "Returns a summary of vulnerability across app stages of your application lifecycle.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "vulnerability-impact-by-stage", + "parameters": [ + { + "name": "asset_type", + "description": "Type of Asset", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ] + } + }, + { + "name": "life_cycle", + "description": "Life Cycle stage", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "code", + "build", + "deploy", + "run" + ] + } + }, + { + "name": "severities", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": "Severity" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImpactByStageResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/dashboard/vulnerabilities/prioritised-vuln": { + "get": { + "summary": "Get Top Impacting Vulnerabilities", + "description": "Returns the CVEs of top critical vulnerabilities in your environment based on the risk score. Each CVE includes risk factors, severity, CVSS, risk factors, and assets impacted.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "top-prioritised-vulnerability", + "parameters": [ + { + "name": "life_cycle", + "description": "Life Cycle stage", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "code", + "build", + "deploy", + "run" + ] + } + }, + { + "name": "top", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "default": 5 + }, + "description": "Number of results to be returned" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TopPrioritizedVulnerabilities" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/dashboard/vulnerabilities/cve-overview": { + "get": { + "summary": "Get CVE Overview", + "description": "Get the overview of the CVE with its CVSS score, the impacted stages, severity, risk factors, the package name, and the distros affected by this CVE.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "cve-overview", + "parameters": [ + { + "name": "cve_id", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": "CVE-2021-44288" + }, + "description": "CVE ID" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CveOverview" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/dashboard/vulnerabilities/vuln-assets": { + "post": { + "summary": "Get Vulnerable Assets by CVE", + "description": "Get the list of all the assets affected by the CVE.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "list-vulnerable-assets-cve", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetsSearchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetSideCarResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + } + }, + "components": { + "schemas": { + "RiskFactorsParam": { + "type": "object", + "properties": { + "riskFactors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SeverityParam": { + "type": "object", + "properties": { + "severity": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OverviewWidget": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Overview" + } + } + } + }, + "Overview": { + "type": "object", + "properties": { + "lastUpdatedDateTime": { + "type": "integer", + "format": "int64" + }, + "totalVulnerabilityCount": { + "type": "integer" + }, + "totalVulnerableAsset": { + "type": "integer" + }, + "totalRemediationCount": { + "type": "integer" + } + } + }, + "PrioritizedVulnerabilities": { + "type": "object", + "properties": { + "lastUpdatedDateTime": { + "type": "integer", + "format": "int64" + }, + "totalVulnerabilities": { + "type": "integer" + }, + "urgent": { + "type": "integer" + }, + "patchable": { + "type": "integer" + }, + "exploitable": { + "type": "integer" + }, + "packageInUse": { + "type": "integer" + } + } + }, + "TopPrioritizedVulnerabilities": { + "type": "object", + "properties": { + "lastUpdatedDateTime": { + "type": "integer", + "format": "int64" + }, + "cve": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cve" + } + } + } + }, + "Cve": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "cvssScore": { + "type": "number", + "format": "double" + }, + "severity": { + "type": "string" + }, + "trends": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Trend" + } + }, + "riskFactors": { + "type": "array", + "items": { + "type": "string" + } + }, + "assetsImpacted": { + "$ref": "#/components/schemas/AssetsImpacted" + } + } + }, + "AssetsImpacted": { + "type": "object", + "properties": { + "codeCount": { + "type": "integer" + }, + "buildCount": { + "type": "integer" + }, + "deployCount": { + "type": "integer" + }, + "runtimeCount": { + "type": "integer" + } + } + }, + "Trend": { + "type": "object", + "properties": { + "reportedDate": { + "type": "integer", + "format": "int64" + }, + "assetsWithCveCount": { + "type": "integer" + } + } + }, + "CveOverview": { + "type": "object", + "properties": { + "cveId": { + "type": "string" + }, + "description": { + "type": "string" + }, + "cvss": { + "type": "number", + "format": "double" + }, + "packageName": { + "type": "string" + }, + "fixVersion": { + "type": "string" + }, + "impactedVersion": { + "type": "string" + }, + "publishedDate": { + "type": "integer", + "format": "int64" + }, + "lifeCycle": { + "type": "array", + "items": { + "type": "string" + } + }, + "riskFactors": { + "type": "array", + "items": { + "type": "string" + } + }, + "severity": { + "type": "string" + }, + "cpuArch": { + "type": "string" + }, + "impactedDistrosList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImpactedDistros" + } + } + } + }, + "ImpactedDistros": { + "type": "object", + "properties": { + "distro": { + "type": "string" + }, + "impactCount": { + "type": "integer" + }, + "distroDetailsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DistroDetails" + } + } + } + }, + "DistroDetails": { + "type": "object", + "properties": { + "cvss": { + "type": "number", + "format": "double" + }, + "packageName": { + "type": "string" + }, + "release": { + "type": "string" + }, + "severity": { + "type": "integer" + }, + "affectedVersion": { + "type": "string" + }, + "fixedTime": { + "type": "integer", + "format": "int64" + } + } + }, + "AssetsSearchRequest": { + "type": "object", + "properties": { + "query": { + "type": "string" + }, + "cve_id": { + "type": "string" + }, + "risk_factors": { + "type": "array", + "items": { + "type": "string" + } + }, + "sort_by": { + "type": "string" + }, + "asset_type": { + "type": "string" + }, + "page_offset": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "filter_suppressed": { + "type": "boolean" + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "target": { + "type": "string", + "description": "Error target" + } + } + }, + "Action": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "status": { + "type": "string" + }, + "actionResult": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "AssetDetails": { + "type": "object", + "properties": { + "assetName": { + "type": "string" + }, + "resourceName": { + "type": "string" + }, + "packageName": { + "type": "string" + }, + "packageVersion": { + "type": "string" + }, + "fixVersion": { + "type": "string" + }, + "severity": { + "type": "string" + }, + "discoveredTime": { + "type": "string" + }, + "remediationAvailable": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Action" + } + }, + "age": { + "type": "integer" + } + } + }, + "AssetSideCarResponse": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetDetails" + } + } + } + }, + "cve_id": { + "type": "string" + }, + "page_offset": { + "type": "integer" + }, + "page_size": { + "type": "integer" + } + } + }, + "ImpactByStageResponse": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "code": { + "type": "object", + "properties": { + "package": { + "type": "integer" + }, + "iac": { + "type": "integer" + } + } + }, + "build": { + "type": "object" + }, + "run": { + "type": "object", + "properties": { + "serverlessFunction": { + "type": "integer" + }, + "host": { + "type": "integer" + }, + "deployedImage": { + "type": "integer" + } + } + }, + "deploy": { + "type": "object", + "properties": { + "registryImage": { + "type": "integer" + }, + "vmImage": { + "type": "integer" + } + } + } + } + } + } + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ] +} diff --git a/openapi-specs/cspm/UVERemediationMicroservice.json b/openapi-specs/cspm/UVERemediationMicroservice.json new file mode 100644 index 000000000..6b0f6fc0f --- /dev/null +++ b/openapi-specs/cspm/UVERemediationMicroservice.json @@ -0,0 +1,560 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "OpenAPI definition", + "version": "v1.10" + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ], + "tags": [ + { + "name": "Unified Vulnerability Explorer", + "description": "API for UVE Vulnerability Remediation Operation " + } + ], + "paths": { + "/uve/api/v1/remediation/vuln-remediation-status": { + "post": { + "summary": "Get Remediation Status", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "fetch-Remediation-Status", + "description": "Get the remediation action status of assets. You can get the remediation status at two levels: \n- **Asset level** - Get the remediation status of an asset by asset ID\n- **Group level** - Get the remediation status of all assets of a specific asset type. To get group level status, specify only the asset type and not the asset ID.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemediationStatusRequest" + }, + "examples": { + "assetLevel": { + "value": { + "cveId": "CVE-2022-32207", + "prismaId": "1115545679050296320", + "assetId": [ + "0230eb1308fcf8dad743549e4092f4af" + ], + "assetType": "host" + } + }, + "groupLevel": { + "value": { + "cveId": "CVE-2022-32207", + "prismaId": "1115545679050296320", + "assetType": "host" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetStatusResponse" + }, + "examples": { + "assetLevel": { + "value": { + "values": [ + { + "prismaId": "1115545679050296320", + "unifiedAssetId": "0230eb1308fcf8dad743549e4092f4af", + "assetType": "host", + "assetLifecycle": "code", + "cveId": "CVE-2022-32207", + "source": "COMPUTE", + "remediationAction": [ + { + "action": "createTask", + "status": "UNAVAILABLE", + "actionResult": "null", + "message": "Invalid Assets" + } + ], + "lastUpdatedTimestamp": 1701782645308 + } + ] + } + }, + "groupLevel": { + "value": { + "values": [ + { + "prismaId": "1115545679050296320", + "unifiedAssetId": "code", + "assetType": "host", + "assetLifecycle": "code", + "cveId": "CVE-2022-32207", + "source": "COMPUTE", + "remediationAction": [ + { + "action": "createTask", + "status": "AVAILABLE", + "actionResult": "null", + "message": "null" + } + ], + "lastUpdatedTimestamp": 1701782708619 + } + ] + } + } + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/remediation/vuln-create-remediation": { + "post": { + "summary": "Create Remediation Request", + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "create-Remediation-Request", + "description": "You create one of the following remediation action request for an asset or a set of assets:\n - Create a task or JIRA ticket \n - Create a merge request \n - Suppress the vulnerability \n\n Remediation action request can be created at the following levels:\n- **Asset level**- Perform remediation action on an asset by asset ID\n - **Group level**- Perform remediation action for all the assets of a particular asset type for a specified CVE ID \n - **Global level**- Perform remediation action on all assets of a specified CVE ID\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "parameters": [ + { + "name": "template-id", + "in": "header", + "description": "JIRA ID. Required only for **createTask** remediation action.", + "schema": { + "type": "string" + } + }, + { + "name": "assignee", + "in": "header", + "description": "JIRA assignee. Required only for **createTask** remediation action.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemediationItem" + }, + "examples": { + "assetLevel": { + "value": { + "cveId": "CVE-2022-0529", + "prismaId": "1115545679050296320", + "source": "COMPUTE", + "remediationAction": "createPr", + "assetDetails": [ + { + "assetType": "package", + "assetId": "31ad4d5160bec151ed7c6bf372442df7" + }, + { + "assetType": "package", + "assetId": "d5160bec151ed7c6bf372442df7" + } + ] + } + }, + "groupLevel": { + "value": { + "cveId": "CVE-2022-0529", + "prismaId": "1115545679050296320", + "source": "BRIDGECREW", + "remediationAction": "suppress", + "assetType": "package" + } + }, + "globalLevel": { + "value": { + "cveId": "CVE-2022-0529", + "prismaId": "1115545679050296320", + "remediationAction": "createTask" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ACCEPTED", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "ACCEPTED", + "description": "Response message" + }, + "details": { + "type": "string", + "example": "", + "description": "Error details if applicable" + }, + "timeStamp": { + "type": "integer", + "example": 1701778720128, + "description": "Timestamp of resppnse" + }, + "request_id": { + "type": "string", + "example": "b17d66dd-2f8c-46f0-be1a-b3e21ba7990c", + "description": "UUID identifier to indentify the request" + } + } + } + } + } + }, + "206": { + "description": "PARTIALLY ACCEPTED", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "PARTIALLY_ACCEPTED", + "description": "Response message" + }, + "details": { + "type": "string", + "example": "Assets are suppressed or Jira Ticket already exists", + "description": "Error details if applicable" + }, + "timeStamp": { + "type": "integer", + "example": 1701778720128, + "description": "Timestamp of resppnse" + }, + "request_id": { + "type": "string", + "example": "b17d66dd-2f8c-46f0-be1a-b3e21ba7990c", + "description": "UUID identifier to indentify the request" + } + } + } + } + } + }, + "400": { + "description": "BAD REQUEST", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "BAD_REQUEST", + "description": "Response message" + }, + "details": { + "type": "string", + "example": "Invalid payload", + "description": "Error details if applicable" + }, + "timeStamp": { + "type": "integer", + "example": 1701778720128, + "description": "Timestamp of resppnse" + }, + "request_id": { + "type": "string", + "example": "b17d66dd-2f8c-46f0-be1a-b3e21ba7990c", + "description": "UUID identifier to indentify the request" + } + } + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + } + }, + "components": { + "schemas": { + "RemediationStatusRequest": { + "type": "object", + "required": [ + "cveId", + "prismaId", + "assetType" + ], + "properties": { + "cveId": { + "type": "string", + "description": "CVE ID of the vulnerability." + }, + "prismaId": { + "type": "string", + "description": "Prisma ID allocated to the customer." + }, + "assetType": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ], + "description": "Asset type" + }, + "assetId": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of asset UAI IDs" + } + } + }, + "RemediationItem": { + "type": "object", + "required": [ + "cveId", + "prismaId", + "remediationAction" + ], + "properties": { + "cveId": { + "type": "string", + "description": "CVE ID of the vulnerability." + }, + "prismaId": { + "type": "string", + "description": "Prisma ID of the customer." + }, + "remediationAction": { + "type": "string", + "enum": [ + "createTask", + "createPr", + "suppress" + ], + "description": "Remediation action: create a JIRA/task, create a PR, or suppress the vulnerability." + }, + "assetType": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ], + "description": "Asset type. Required only for group level remediation." + }, + "assetId": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assetType": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ], + "description": "Type of asset." + }, + "assetId": { + "type": "string", + "description": "UAI ID of the asset." + } + } + }, + "description": "Asset IDs. Required only for asset level remediation." + } + } + }, + "GetStatusResponse": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "object", + "properties": { + "prismaId": { + "type": "string", + "description": "prisma ID of the customer" + }, + "unifiedAssetId": { + "type": "string", + "description": "Unified asset ID of the asset" + }, + "assetType": { + "type": "string", + "enum": [ + "iac", + "package", + "deployedImage", + "serverlessFunction", + "host", + "registryImage", + "vmImage" + ], + "description": "Asset type of the asset" + }, + "assetLifecycle": { + "type": "string", + "enum": [ + "code", + "build", + "deploy", + "run" + ], + "description": "Life cycle of the asset" + }, + "cveId": { + "type": "string", + "description": "CVE ID affecting the asset" + }, + "source": { + "type": "string", + "enum": [ + "COMPUTE", + "BRIDGECREW" + ], + "description": "If the asset if Bridgecrew/Compute (placeholder, usually empty/null)" + }, + "remediationAction": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "The remediation action", + "enum": [ + "createTask", + "createPr", + "suppress" + ] + }, + "status": { + "type": "string", + "description": "If the asset is AVAILABLE/ not so because of a certain reason", + "enum": [ + "AVAILABLE", + "IN_PROGRESS", + "SUBMITTED", + "DONE", + "UNAVAILABLE", + "SUPPRESSED" + ] + }, + "actionResult": { + "type": "string", + "description": "The JIRA link/PR link of the remediated asset if applicable" + }, + "message": { + "type": "string", + "description": "Reason for the current 'status' if applicable" + } + } + }, + "description": "Remediation actions available for the asset type" + }, + "lastUpdatedTimestamp": { + "type": "integer", + "description": "The timestamp as of which the status was identified" + } + } + } + } + } + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + } +} diff --git a/openapi-specs/cspm/UVESearchMicroService.json b/openapi-specs/cspm/UVESearchMicroService.json new file mode 100644 index 000000000..8b38cca45 --- /dev/null +++ b/openapi-specs/cspm/UVESearchMicroService.json @@ -0,0 +1,629 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Vulnerability Search and Investigate API", + "description": "Endpoint to search for vulnerabilities", + "version": "1.0.0" + }, + "tags": [ + { + "name": "Unified Vulnerability Explorer", + "description": "Endpoint to search for vulnerabilities" + } + ], + "paths": { + "/uve/api/v1/vulnerabilities/search": { + "post": { + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "vulnerabilities-search-api", + "summary": "Get Vulnerabilities by RQL", + "description": "Get the list of vulnerabilities and their details based on an RQL query. For vulnerability RQL query attributes, see [Vulnerability Query Attributes](https://docs.prismacloud.io/en/enterprise-edition/content-collections/search-and-investigate/vulnerability-queries/vulnerability-query-attributes). For example queries, see [Vulnerability Query Examples](https://docs.prismacloud.io/en/enterprise-edition/content-collections/search-and-investigate/vulnerability-queries/vulnerability-query-examples).\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VulnerabilitySearchRequest" + } + } + } + }, + "parameters": [ + { + "name": "page_token", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Token for pagination" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VulnerabilitySearchResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/vulnerabilities/search/asset": { + "post": { + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "list-vulnerable-assets", + "summary": "Get Vulnerable Assets by RQL", + "description": "Get the list of vulnerable Assets and their IDs based on an RQL query. For vulnerability RQL query attributes, see [Vulnerability Query Attributes](https://docs.prismacloud.io/en/enterprise-edition/content-collections/search-and-investigate/vulnerability-queries/vulnerability-query-attributes). For example queries, see [Vulnerability Query Examples](https://docs.prismacloud.io/en/enterprise-edition/content-collections/search-and-investigate/vulnerability-queries/vulnerability-query-examples).\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetsSearchRequest" + } + } + } + }, + "parameters": [ + { + "name": "page_token", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Token for pagination" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetsSearchResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + }, + "/uve/api/v1/vulnerabilities/download": { + "post": { + "tags": [ + "Unified Vulnerability Explorer" + ], + "operationId": "download-vulnerability-file", + "summary": "Download CVE Details", + "description": "Download the CVE details and impacted assets by CVE ID in a GZIP CSV format.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VulnerabilityDownloadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-public": "true", + "x-ga": "24.1.1-darwin", + "security": [ + { + "x-redlock-auth": [] + } + ] + } + } + }, + "components": { + "schemas": { + "VulnerabilitySearchRequest": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "Search query", + "example": "vulnerability where age > 30 days" + }, + "id": { + "type": "string", + "description": "saved search ID" + } + }, + "required": [ + "query" + ] + }, + "VulnerabilitySearchResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Saved search ID" + }, + "name": { + "type": "string", + "description": "Vulnerability name" + }, + "description": { + "type": "string", + "description": "Vulnerability description" + }, + "searchType": { + "type": "string", + "description": "Search type" + }, + "saved": { + "type": "boolean", + "description": "Whether it's saved or not" + }, + "timeRange": { + "$ref": "#/components/schemas/ToNowTimeRange" + }, + "query": { + "type": "string", + "description": "Query details" + }, + "data": { + "$ref": "#/components/schemas/VulnerabilitySearchResultData" + } + } + }, + "VulnerabilitySearchResultData": { + "type": "object", + "properties": { + "totalRows": { + "type": "integer", + "description": "Total number of rows" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CveDetails" + } + }, + "nextPageToken": { + "type": "string", + "description": "Token for next page" + } + } + }, + "CveDetails": { + "type": "object", + "properties": { + "cveId": { + "type": "string", + "description": "CVE ID" + }, + "name": { + "type": "string", + "description": "Name" + }, + "cvssScore": { + "type": "number", + "description": "CVSS Score", + "example": 8 + }, + "totalImpactedAssets": { + "type": "integer", + "description": "Total Impacted Assets" + }, + "riskFactors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Risk Factors" + }, + "code": { + "$ref": "#/components/schemas/Code" + }, + "build": { + "$ref": "#/components/schemas/Build" + }, + "deploy": { + "$ref": "#/components/schemas/Deploy" + }, + "run": { + "$ref": "#/components/schemas/Run" + }, + "published": { + "type": "integer", + "description": "Published time" + }, + "exploitable": { + "type": "boolean", + "description": "Exploitable" + }, + "patchable": { + "type": "boolean", + "description": "Patchable" + }, + "severity": { + "type": "string", + "description": "Severity" + } + } + }, + "ToNowTimeRange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of Time Range" + }, + "value": { + "type": "string", + "description": "Value of Time Range" + } + } + }, + "AssetsSearchRequest": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "Search query", + "example": "vulnerability where age > 30 days" + }, + "cveId": { + "type": "string", + "description": "CVE ID" + }, + "assetLifecycle": { + "type": "string", + "description": "Asset Lifecycle", + "enum": [ + "code", + "build", + "deploy", + "run" + ] + }, + "assetType": { + "type": "string", + "description": "Asset Type", + "enum": [ + "package", + "serverlessFunction", + "iac", + "deployedImage", + "vmImage", + "registryImage", + "host" + ] + } + }, + "required": [ + "query", + "cveId", + "assetLifecycle", + "assetType" + ] + }, + "AssetsSearchResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetInfo" + }, + "description": "List of Asset Information" + }, + "nextPageToken": { + "type": "string", + "description": "Token for next page" + } + } + }, + "AssetInfo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Asset ID" + }, + "name": { + "type": "string", + "description": "Asset name" + } + } + }, + "AutoSuggestRequest": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "Suggestion query" + } + } + }, + "AutoSuggestInfo": { + "type": "object", + "properties": { + "valid": { + "type": "boolean", + "description": "Validity of suggestions" + }, + "suggestions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of suggestions" + }, + "translate": { + "type": "boolean", + "description": "Translate flag" + }, + "needsOffsetUpdate": { + "type": "boolean", + "description": "Offset update flag" + }, + "offset": { + "type": "integer", + "description": "Offset value" + } + } + }, + "Code": { + "type": "object" + }, + "Build": { + "type": "object" + }, + "Deploy": { + "type": "object" + }, + "Run": { + "type": "object" + }, + "VulnerabilityRQLToJsonResponse": { + "type": "object", + "properties": { + "original": { + "type": "string", + "description": "Original string" + }, + "transformed": { + "type": "string", + "description": "Transformed string" + } + } + }, + "VulnerabilityDownloadRequest": { + "type": "object", + "required": [ + "cveId" + ], + "properties": { + "cveId": { + "type": "string", + "description": "CVE ID" + }, + "riskFactors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of risk factors" + }, + "assetType": { + "type": "string", + "description": "Asset Type", + "enum": [ + "package", + "serverlessFunction", + "iac", + "deployedImage", + "vmImage", + "registryImage", + "host" + ] + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "target": { + "type": "string", + "description": "Error target" + } + } + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ] +} diff --git a/openapi-specs/cspm/UserProfile.json b/openapi-specs/cspm/UserProfile.json index 4d3aa9f21..972297a19 100644 --- a/openapi-specs/cspm/UserProfile.json +++ b/openapi-specs/cspm/UserProfile.json @@ -381,9 +381,6 @@ }, "400": { "description": "user_inactive_or_not_exist" - }, - "500": { - "description": "failed_fetch_user_profile" } }, "security": [ @@ -419,9 +416,6 @@ }, "403": { "description": "cannot_disable_own_profile / access_keys_cannot_update_owner_profile" - }, - "500": { - "description": "failed_update_user_profile" } }, "security": [ @@ -452,9 +446,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_user_profile" } }, "security": [ @@ -497,9 +488,6 @@ }, "409": { "description": "duplicate_user_name" - }, - "500": { - "description": "failed_add_user_profile" } }, "security": [ @@ -530,9 +518,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_user_profile" } }, "security": [ @@ -568,9 +553,6 @@ }, "409": { "description": "duplicate_user_name" - }, - "500": { - "description": "failed_add_user_profile" } }, "security": [ @@ -613,9 +595,6 @@ }, "400": { "description": "user_inactive_or_not_exist" - }, - "500": { - "description": "failed_fetch_user_profile" } }, "security": [ @@ -661,9 +640,6 @@ }, "403": { "description": "cannot_remove_current_log_in_role" - }, - "500": { - "description": "failed_update_user_profile" } }, "security": [ @@ -702,9 +678,6 @@ }, "403": { "description": "cannot_delete_own_profile" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -779,9 +752,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_users_emails" } }, "security": [ @@ -815,9 +785,6 @@ }, "400": { "description": "no_user_added" - }, - "500": { - "description": "failed_fetch_email_domain_allow_list" } }, "security": [ @@ -849,9 +816,6 @@ } }, "description": "successful operation" - }, - "500": { - "description": "failed_fetch_sso_bypass_allowed_users" } }, "security": [ @@ -887,9 +851,6 @@ }, "400": { "description": "missing_sso_bypass_allowed_users" - }, - "500": { - "description": "failed_update_sso_bypass_allowed_users" } }, "security": [ diff --git a/openapi-specs/cspm/UserRoles.json b/openapi-specs/cspm/UserRoles.json index 2917bc522..808cb8d1e 100644 --- a/openapi-specs/cspm/UserRoles.json +++ b/openapi-specs/cspm/UserRoles.json @@ -263,9 +263,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -301,9 +298,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -340,9 +334,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -439,9 +430,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -488,9 +476,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ @@ -526,9 +511,6 @@ }, "403": { "description": "unauthorized_access" - }, - "500": { - "description": "internal_error" } }, "security": [ diff --git a/openapi-specs/cspm/WidgetMicroService.json b/openapi-specs/cspm/WidgetMicroService.json new file mode 100644 index 000000000..389c09106 --- /dev/null +++ b/openapi-specs/cspm/WidgetMicroService.json @@ -0,0 +1,637 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Widget APIs", + "contact": {}, + "license": { + "name": "Public" + }, + "version": "v1" + }, + "servers": [ + { + "url": "https://api.prismacloud.io" + }, + { + "url": "https://api2.prismacloud.io" + }, + { + "url": "https://api3.prismacloud.io" + }, + { + "url": "https://api4.prismacloud.io" + }, + { + "url": "https://api.anz.prismacloud.io" + }, + { + "url": "https://api.eu.prismacloud.io" + }, + { + "url": "https://api2.eu.prismacloud.io" + }, + { + "url": "https://api.gov.prismacloud.io" + }, + { + "url": "https://api.prismacloud.cn" + }, + { + "url": "https://api.ca.prismacloud.io" + }, + { + "url": "https://api.sg.prismacloud.io" + }, + { + "url": "https://api.uk.prismacloud.io" + }, + { + "url": "https://api.ind.prismacloud.io" + }, + { + "url": "https://api.jp.prismacloud.io" + }, + { + "url": "https://api.fr.prismacloud.io" + } + ], + "tags": [ + { + "name": "Widgets", + "description": "These APIs are used to fetch the data from some of the widgets that are used to create custom dashboard." + } + ], + "paths": { + "/adoptionadvisor/api/v2/compute/discovered-secured/trend": { + "post": { + "tags": [ + "Widgets" + ], + "summary": "Get Discovered and Secured Resources", + "description": "Get resources detected by Cloud Discovery as well as the resources secured by deployed defenders.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "value-widgets-get-discovered-vs-secured", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CWPWidgetRequestModel" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json; charset=UTF-8": { + "schema": { + "$ref": "#/components/schemas/DiscoverVsSecuredResponse" + } + } + } + }, + "400": { + "description": "bad_request", + "content": {} + }, + "401": { + "description": "unauthorized_access", + "content": {} + }, + "403": { + "description": "unauthorized", + "content": {} + }, + "429": { + "content": {} + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-ga": "24.1.1-darwin", + "x-public": "true", + "x-codegen-request-body-name": "body" + } + }, + "/adoptionadvisor/api/v2/compute/vulnerabilities/trend": { + "post": { + "tags": [ + "Widgets" + ], + "summary": "Get Vulnerabilities Trend", + "description": "Get vulnerabilities discovered and resolved over time across images, hosts, functions, and containers for the impacted resources.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "value-widgets-get-vulnerabilities-trend", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CWPWidgetRequestModel" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json; charset=UTF-8": { + "schema": { + "$ref": "#/components/schemas/VulnerabilitiesTrendResponse" + } + } + } + }, + "400": { + "description": "bad_request", + "content": {} + }, + "401": { + "description": "unauthorized_access", + "content": {} + }, + "403": { + "description": "unauthorized", + "content": {} + }, + "429": { + "content": {} + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-ga": "24.1.1-darwin", + "x-public": "true", + "x-codegen-request-body-name": "body" + } + }, + "/adoptionadvisor/api/v2/cspm/riskyasset/trend": { + "post": { + "tags": [ + "Widgets" + ], + "summary": "Get Assets with Alerts", + "description": "Get the list of assets generating alerts.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n", + "operationId": "value-widgets-get-assets-with-alerts", + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AssetsWithAlertsRequestModel" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json; charset=UTF-8": { + "schema": { + "$ref": "#/components/schemas/AssetsWithUrgentAlerts" + } + } + } + }, + "400": { + "description": "bad_request", + "content": {} + }, + "401": { + "description": "unauthorized_access", + "content": {} + }, + "403": { + "description": "unauthorized", + "content": {} + }, + "429": { + "content": {} + } + }, + "security": [ + { + "x-redlock-auth": [] + } + ], + "x-ga": "24.1.1-darwin", + "x-public": "true", + "x-codegen-request-body-name": "body" + } + } + }, + "components": { + "schemas": { + "AssetsWithAlertsFilter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the allowed Filter types.", + "enum": [ + "CLOUD_TYPE", + "ALERT_SEVERITY" + ] + }, + "operator": { + "type": "string", + "description": "Only allowed operator for the filter is '='" + }, + "value": { + "type": "string", + "description": "Value for the applied filter" + } + } + }, + "AssetsWithAlertsRequestModel": { + "type": "object", + "properties": { + "filters": { + "type": "array", + "description": "List of filters that can be applied for the API", + "items": { + "$ref": "#/components/schemas/AssetsWithAlertsFilter" + } + }, + "timeRange": { + "$ref": "#/components/schemas/TimeRangeConfigModel" + } + }, + "description": "Model for Assets With Alerts Request" + }, + "AssetsWithUrgentAlerts": { + "type": "object", + "properties": { + "privilege": { + "type": "string", + "description": "privilege" + }, + "assetsWithAlerts": { + "type": "array", + "description": "Assets with Alerts", + "items": { + "$ref": "#/components/schemas/DailyAssetWithUrgentAlerts" + } + }, + "rowCount": { + "type": "integer", + "description": "Row count", + "format": "int32" + } + }, + "description": "Model for Assets With Urgent Alerts Widget api response" + }, + "CWPWidgetRequestModel": { + "type": "object", + "properties": { + "timeRange": { + "$ref": "#/components/schemas/TimeRangeConfigModel" + } + }, + "description": "Model for Discovered vs Secured and Vulnerabilities Trend" + }, + "DailyAssetWithUrgentAlerts": { + "type": "object", + "properties": { + "criticalAssets": { + "type": "integer", + "description": "criticalAssets", + "format": "int64" + }, + "highAssets": { + "type": "integer", + "description": "highAssets", + "format": "int64" + }, + "mediumAssets": { + "type": "integer", + "description": "mediumAssets", + "format": "int64" + }, + "lowAssets": { + "type": "integer", + "description": "lowAssets", + "format": "int64" + }, + "informationalAssets": { + "type": "integer", + "description": "informationalAssets", + "format": "int64" + }, + "alertsByCloudType": { + "type": "array", + "description": "alerts", + "items": { + "$ref": "#/components/schemas/DiscoverVsSecured" + } + }, + "insertTs": { + "type": "integer", + "description": "insertTs", + "format": "int64" + } + }, + "description": "Model for daily Assets With Urgent Alerts" + }, + "DiscoverVsSecured": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "cloudType" + }, + "critical": { + "type": "integer", + "description": "critical", + "format": "int64" + }, + "high": { + "type": "integer", + "description": "high", + "format": "int64" + }, + "medium": { + "type": "integer", + "description": "medium", + "format": "int64" + }, + "low": { + "type": "integer", + "description": "low", + "format": "int64" + }, + "informational": { + "type": "integer", + "description": "informational", + "format": "int64" + } + }, + "description": "cloud type and alerts count" + }, + "DiscoverVsSecuredResponse": { + "type": "object", + "properties": { + "rowCount": { + "type": "integer", + "description": "Row count", + "format": "int32" + }, + "privilege": { + "type": "string", + "description": "privilege" + }, + "rows": { + "type": "array", + "description": "List of vulnerabilities trend data", + "items": { + "$ref": "#/components/schemas/DiscoverVsSecured" + } + } + }, + "description": "Model for Discover vs Secured Widget Response" + }, + "RelativeTimeDurationModel": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "Time unit", + "enum": [ + "minute", + "hour", + "day", + "week", + "month", + "year" + ] + }, + "amount": { + "type": "integer", + "description": "Number of time units", + "format": "int32" + } + }, + "description": "Model for RelativeTimeDuration" + }, + "RelativeTimeRangeConfigModel": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeRangeConfigModel" + }, + { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/RelativeTimeDurationModel" + }, + "relativeTimeType": { + "type": "string", + "description": "Direction in which to count time. Default = BACKWARD", + "enum": [ + "BACKWARD", + "FORWARD" + ] + } + }, + "description": "Model for RelativeTimeRangeConfig" + } + ] + }, + "TimeModel": { + "type": "object", + "properties": { + "startTime": { + "type": "integer", + "description": "Start timestamp", + "format": "int64" + }, + "endTime": { + "type": "integer", + "description": "End timestamp", + "format": "int64" + } + }, + "description": "Model for Time" + }, + "TimeRangeConfigModel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Time type", + "enum": [ + "relative" + ] + }, + "value": { + "$ref": "#/components/schemas/RelativeTimeDurationModel" + } + }, + "description": "Model for TimeRangeConfig", + "discriminator": { + "propertyName": "type" + } + }, + "ToNowTimeRangeConfigModel": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeRangeConfigModel" + }, + { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Time range object", + "enum": [ + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "YEAR", + "EPOCH", + "LOGIN" + ] + } + }, + "description": "Model for ToNowTimeRangeConfig" + } + ] + }, + "VulnerabilitiesTrend": { + "type": "object", + "properties": { + "ts": { + "type": "integer", + "description": "timestamp", + "format": "int64" + }, + "vulStatsImageC": { + "type": "integer", + "description": "vulStatsImageC", + "format": "int64" + }, + "vulStatsImageH": { + "type": "integer", + "description": "vulStatsImageH", + "format": "int64" + }, + "vulStatsImageM": { + "type": "integer", + "description": "vulStatsImageM", + "format": "int64" + }, + "vulStatsImageL": { + "type": "integer", + "description": "vulStatsImageL", + "format": "int64" + }, + "vulStatsHostC": { + "type": "integer", + "description": "vulStatsHostC", + "format": "int64" + }, + "vulStatsHostH": { + "type": "integer", + "description": "vulStatsHostH", + "format": "int64" + }, + "vulStatsHostM": { + "type": "integer", + "description": "vulStatsHostM", + "format": "int64" + }, + "vulStatsHostL": { + "type": "integer", + "description": "vulStatsHostL", + "format": "int64" + }, + "vulStatsContainerC": { + "type": "integer", + "description": "vulStatsContainerC", + "format": "int64" + }, + "vulStatsContainerH": { + "type": "integer", + "description": "vulStatsContainerH", + "format": "int64" + }, + "vulStatsContainerM": { + "type": "integer", + "description": "vulStatsContainerM", + "format": "int64" + }, + "vulStatsContainerL": { + "type": "integer", + "description": "vulStatsContainerL", + "format": "int64" + }, + "vulStatsFunctionC": { + "type": "integer", + "description": "vulStatsFunctionC", + "format": "int64" + }, + "vulStatsFunctionH": { + "type": "integer", + "description": "vulStatsFunctionH", + "format": "int64" + }, + "vulStatsFunctionM": { + "type": "integer", + "description": "vulStatsFunctionM", + "format": "int64" + }, + "vulStatsFunctionL": { + "type": "integer", + "description": "vulStatsFunctionL", + "format": "int64" + } + }, + "description": "timestamp, vulnerability stats" + }, + "VulnerabilitiesTrendResponse": { + "type": "object", + "properties": { + "rowCount": { + "type": "integer", + "description": "Row count", + "format": "int32" + }, + "privilege": { + "type": "string", + "description": "privilege" + }, + "rows": { + "type": "array", + "description": "List of vulnerabilities trend data", + "items": { + "$ref": "#/components/schemas/VulnerabilitiesTrend" + } + } + }, + "description": "Model for Vulnerabilities Trend Response" + } + }, + "securitySchemes": { + "x-redlock-auth": { + "description": "The x-redlock-auth value is a JSON Web Token (JWT).", + "in": "header", + "name": "x-redlock-auth", + "type": "apiKey" + } + } + }, + "x-original-swagger-version": "2.0" +} diff --git a/openapi-specs/cspm/adjustSpecFilesForPanDev.sh b/openapi-specs/cspm/adjustSpecFilesForPanDev.sh index e40da9e68..188a9faf1 100755 --- a/openapi-specs/cspm/adjustSpecFilesForPanDev.sh +++ b/openapi-specs/cspm/adjustSpecFilesForPanDev.sh @@ -61,6 +61,9 @@ for file in *.json; do # delete code snippets jq '.paths |= del(.[][]."x-codeSamples")' | \ + # delete all 5xx error from endpoints + jq '.paths |= del(.[][].responses | .[keys[] | select(contains("5xx","5XX","500", "501", "502","503", "504", "505", "506", "507", "508","509","510","511", "529", "530","598","599"))])' | \ + # add server urls jq '.servers |= [ {"url":"https://api.prismacloud.io"}, diff --git a/openapi-specs/cspm/code2cloudMicroService.json b/openapi-specs/cspm/code2cloudMicroService.json index 69e2af546..7bdc10322 100644 --- a/openapi-specs/cspm/code2cloudMicroService.json +++ b/openapi-specs/cspm/code2cloudMicroService.json @@ -58,19 +58,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable" } }, "security": [ @@ -129,19 +116,6 @@ }, "429": { "description": "Too Many Requests" - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "503": { - "description": "Service unavailable" } }, "security": [ diff --git a/openapi-specs/cspm/consolidated_spec/all_endpoints.csv b/openapi-specs/cspm/consolidated_spec/all_endpoints.csv index 4f4d8862b..29a274c30 100644 --- a/openapi-specs/cspm/consolidated_spec/all_endpoints.csv +++ b/openapi-specs/cspm/consolidated_spec/all_endpoints.csv @@ -86,6 +86,10 @@ "post","/v3/inventory/trend","Asset Inventory Trend View V3 - POST","post-method-asset-inventory-trend-v3","Asset Inventory","Monolith" "post","/uai/v1/asset","Get Asset","get-asset-details-by-id","Asset Explorer","AssetMicroService.json" "get","/audit/redlock","Prisma Cloud Audit Logs","rl-audit-logs","Audit Logs","Monolith" +"get","/report-service/api/v1/report","Get Reports Metadata","list-reports","Background Jobs","BackgroundJobsMicroService.json" +"get","/report-service/api/v1/report/{reportId}","Get Report Metadata by ID","get-report-metadata-by-id","Background Jobs","BackgroundJobsMicroService.json" +"get","/report-service/api/v1/report/{reportId}/status","Get Report Status","get-report-status-by-id","Background Jobs","BackgroundJobsMicroService.json" +"get","/report-service/api/v1/report/{reportId}/download","Download a report","download-report-by-id","Background Jobs","BackgroundJobsMicroService.json" "post","/asm/api/v1/convert-cloud-account","Onboard Cloud Accounts","onboardCloudAccounts","Cloud Discovery and Exposure Management","CDEMMicroServices.json" "post","/asm/api/v1/asset","Get Assets List","asset-inventory-for-l3","Cloud Discovery and Exposure Management","CDEMMicroServices.json" "post","/asm/api/v1/asset/{asset_id}/finding","Get Findings of an Asset ","getAssetFindings","Cloud Discovery and Exposure Management","CDEMMicroServices.json" @@ -279,11 +283,21 @@ "post","/api/v1/idp/integration/test","Test IDP Integration","test-integration-with-post","IAM IDP","IAMIdpMicroService.json" "post","/api/v1/permission","Get Permissions","get-permissions-with-post","IAM","IAMMicroService.json" "post","/api/v1/permission/page","Get Permissions Next Page","get-next-permissions-page-with-post","IAM","IAMMicroService.json" -"post","/api/v1/permission/access","Get Permissions Access","get-permissions-access-with-post","IAM","IAMMicroService.json" +"post","/api/v1/permission/access","Get Permission Accesses","get-permissions-access-with-post","IAM","IAMMicroService.json" "post","/api/v1/permission/access/page","Get Permissions Access Next Page","get-next-permissions-access-with-post","IAM","IAMMicroService.json" "post","/api/v1/permission/alert/remediation","Get Remediation","get-remediation-with-post","IAM","IAMMicroService.json" "get","/api/v1/permission/alert/search","Get IAM Query","get-rql-with-get","IAM","IAMMicroService.json" "post","/api/v1/suggest","Get Query Suggestions","get-suggestions-with-post","IAM","IAMMicroService.json" +"post","/iam/api/v3/search/permission","Get Permissions V3","search-permissions-v3","IAM","IAMV2MicroService.json" +"post","/iam/api/v3/permission/{permission-id}/list_access","Get Permission Accesses V3","permissions-accesses-v3","IAM","IAMV2MicroService.json" +"post","/iam/api/v2/suggestion","Get Query Suggestions V2","iam-suggest-v2","IAM","IAMV2MicroService.json" +"post","/iam/api/v2/search/iam_config","Get Permissions Role or Policy Definition V2","permission-raw-config-definition","IAM","IAMV2MicroService.json" +"post","/iam/api/v1/asset/{asset-id}/related-asset","Get Cloud Identity Inventory (CII) Resource Related Assets","cii-related-assets-v1","IAM","IAMV2MicroService.json" +"get","/iam/api/v2/alert/{alertId}/remediation_command","Get Remediation Command","alert-remediation-command","IAM","IAMV2MicroService.json" +"get","/iam/api/v2/alert/{alertId}/query","Get IAM Query V2","investigate-alert","IAM","IAMV2MicroService.json" +"get","/iam/api/v1/assets/{assetId}/over-permissive-metadata","Get Least Privilege Access Metadata of an Asset","least-privilege-access-metadata-v1","IAM","IAMV2MicroService.json" +"get","/iam/api/v1/assets/{assetId}/existing-least-privileged-access","Get Existing Least Privilege Access Suggestions for an Asset","existing-least-privilege-access-v1","IAM","IAMV2MicroService.json" +"get","/iam/api/v1/assets/{assetId}/custom-least-privileged-access","Get New Least Privilege Access Suggestions for an Asset","custom-least-privilege-access-v1","IAM","IAMV2MicroService.json" "get","/allow_list/network","List Networks","get-networks-list","IP Allow List","Monolith" "post","/allow_list/network","Add Network","add-a-network","IP Allow List","Monolith" "get","/allow_list/network/{networkUuid}","Network Info","get-network-info","IP Allow List","Monolith" @@ -412,6 +426,17 @@ "get","/settings/enterprise","Enterprise Settings - GET","get-enterprise-settings","Settings","Monolith" "post","/settings/enterprise","Enterprise Settings - POST","update-enterprise-settings","Settings","Monolith" "get","/check","Health Check","health-check","System","Monolith" +"get","/uve/api/v1/dashboard/vulnerabilities/overview","Get Vulnerability Overview","vulnerability-dashboard-overview","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"get","/uve/api/v1/dashboard/vulnerabilities/prioritised","Get Prioritized Vulnerabilities","prioritised-vulnerability","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"get","/uve/api/v1/dashboard/vulnerabilities/impact-stage","Get Vulnerability Impact by Stage","vulnerability-impact-by-stage","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"get","/uve/api/v1/dashboard/vulnerabilities/prioritised-vuln","Get Top Impacting Vulnerabilities","top-prioritised-vulnerability","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"get","/uve/api/v1/dashboard/vulnerabilities/cve-overview","Get CVE Overview","cve-overview","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"post","/uve/api/v1/dashboard/vulnerabilities/vuln-assets","Get Vulnerable Assets by CVE","list-vulnerable-assets-cve","Unified Vulnerability Explorer","UVEDashboardMicroService.json" +"post","/uve/api/v1/remediation/vuln-remediation-status","Get Remediation Status","fetch-Remediation-Status","Unified Vulnerability Explorer","Monolith" +"post","/uve/api/v1/remediation/vuln-create-remediation","Create Remediation Request","create-Remediation-Request","Unified Vulnerability Explorer","Monolith" +"post","/uve/api/v1/vulnerabilities/search","Get Vulnerabilities by RQL","vulnerabilities-search-api","Unified Vulnerability Explorer","UVESearchMicroService.json" +"post","/uve/api/v1/vulnerabilities/search/asset","Get Vulnerable Assets by RQL","list-vulnerable-assets","Unified Vulnerability Explorer","UVESearchMicroService.json" +"post","/uve/api/v1/vulnerabilities/download","Download CVE Details","download-vulnerability-file","Unified Vulnerability Explorer","UVESearchMicroService.json" "get","/user/me","Profile","get-my-profile","User Profile","Monolith" "put","/user/me","Update Profile","update-my-profile","User Profile","Monolith" "get","/v3/user","List Users V3","get-user-profiles-v3","User Profile","Monolith" @@ -433,5 +458,8 @@ "get","/user/role/{id}","User Role Info","get-user-role","User Roles","Monolith" "put","/user/role/{id}","Update User Role","update-user-role","User Roles","Monolith" "delete","/user/role/{id}","Delete User Role","delete-user-role","User Roles","Monolith" +"post","/adoptionadvisor/api/v2/compute/discovered-secured/trend","Get Discovered and Secured Resources","value-widgets-get-discovered-vs-secured","Widgets","WidgetMicroService.json" +"post","/adoptionadvisor/api/v2/compute/vulnerabilities/trend","Get Vulnerabilities Trend","value-widgets-get-vulnerabilities-trend","Widgets","WidgetMicroService.json" +"post","/adoptionadvisor/api/v2/cspm/riskyasset/trend","Get Assets with Alerts","value-widgets-get-assets-with-alerts","Widgets","WidgetMicroService.json" "get","/c2c/api/v1/deploy/trend","List Deploy Trend","code-to-cloud-list-deploy-trend","Code to Cloud","code2cloudMicroService.json" "get","/c2c/api/v1/runtime/trend","List Runtime Trend","code-to-cloud-list-runtime-trend","Code to Cloud","code2cloudMicroService.json"