Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cloud Security API 24.9.2 #741

Merged
merged 10 commits into from
Sep 20, 2024
Merged

Cloud Security API 24.9.2 #741

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
16deabd
RLP-149246 AssetMicroservice data security for DSPM released in 24.9.1
jrdevore Sep 9, 2024
e4fac38
Fix spec file parsing issue
jrdevore Sep 9, 2024
87b77e5
RLP-149539 updates
AbiMano4688 Sep 11, 2024
a7024d2
Revert "RLP-149539 updates"
AbiMano4688 Sep 11, 2024
47fc318
Logging Accounts APIs
AbiMano4688 Sep 17, 2024
6627ff6
new UVE POST APIs
AbiMano4688 Sep 17, 2024
a03d4e0
edits to markdown syntax
AbiMano4688 Sep 18, 2024
bb3dbf8
added x-public to all public endpoints
AbiMano4688 Sep 18, 2024
7dceaf2
Merge branch 'master' into 24.9.2
AbiMano4688 Sep 19, 2024
9f0d080
RLP-149246 AssetMicroService - Restore description for Get Asset endp…
jrdevore Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 71 additions & 82 deletions openapi-specs/cspm/AssetMicroService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
{
"openapi": "3.0.1",
"info": {
"title": "Prisma Cloud Unified Asset Inventory",
"description": "All assets known to Prisma Cloud with a comprehensive Asset Service",
"title": "APIs to query unified asset",
"description": "APIs to query data from Unified Asset Inventory (UAI)",
jrdevore marked this conversation as resolved.
Show resolved Hide resolved
"contact": {
"name": "Slack Us",
"url": "https://panw-rnd.slack.com/archives/C01DQJBJ7LJ",
"email": "pcs-scrum-platform-da-aaaacvlzsrzhfngxbqrn5mqpre@paloaltonetworks.org.slack.com"
"name": "Platform-Ironman",
"url": ""
},
"version": "V1"
"version": "v1.0"
},
"servers": [
{
Expand Down Expand Up @@ -57,14 +56,19 @@
"url": "https://api.fr.prismacloud.io"
}
],
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"name": "Asset Lookup",
"description": "All assets known to Prisma Cloud with a comprehensive Asset Service"
"description": "APIs to query data from Unified Asset Inventory (UAI)"
},
{
"name": "Id Translations",
"description": "All assets known to Prisma Cloud with a comprehensive Asset Service"
"description": "APIs to query data from Unified Asset Inventory (UAI)"
jrdevore marked this conversation as resolved.
Show resolved Hide resolved
}
],
"paths": {
Expand All @@ -74,7 +78,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 parameter with type as follows: \n\n | **Type** | **Conditionally Required Query Parameters** |\n| ------------------------------- | ----------------------------------------------------------------- |\n| external_finding | <ul><li>findingType</li><li>riskFactors </li></ul> |\n| alerts | alertIds |\n| attack_path | attackPathIds |\n| package_info | <ul><li>vulnerabilityInfoTypeId</li><li>filters</li></ul> |\n| labels | filters |\n| vulnerability_aggregates | filters |\n| process_info | filters |\n| vulnerabilities_group_by_type |<ul><li>vulnerabilityInfoTypeId</li><li> filters</li></ul> |\n| asset_cwp_vulns |<ul><li>vulnerabilityInfoTypeId</li><li>vulnerabilityInfoType</li><li>filters</li></ul> |\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.",
jrdevore marked this conversation as resolved.
Show resolved Hide resolved
"operationId": "get-asset-details-by-id",
"parameters": [],
"requestBody": {
Expand Down Expand Up @@ -157,39 +161,26 @@
"type": "object",
"properties": {
"ids": {
"maximum": 200,
"minimum": 1,
"type": "array",
"format": "IdLookup",
"example": "[d49d2177f00f7ce4ab24bb86655efad4]",
"items": {
"maximum": 200,
"minimum": 1,
"type": "string",
"format": "IdLookup",
"example": "[d49d2177f00f7ce4ab24bb86655efad4]"
"example": "d49d2177f00f7ce4ab24bb86655efad4"
}
}
},
"description": "Request object for id translation"
},
"Problem": {
"required": [
"createdTs",
"parameters"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
"$ref": "#/components/schemas/StatusType"
},
"detail": {
"type": "string"
Expand All @@ -198,9 +189,9 @@
"type": "string",
"format": "uri"
},
"createdTs": {
"type": "integer",
"format": "int64"
"type": {
"type": "string",
"format": "uri"
},
"parameters": {
"type": "object",
Expand Down Expand Up @@ -230,12 +221,12 @@
"StatusType": {
"type": "object",
"properties": {
"reasonPhrase": {
"type": "string"
},
"statusCode": {
"type": "integer",
"format": "int32"
},
"reasonPhrase": {
"type": "string"
}
}
},
Expand Down Expand Up @@ -321,12 +312,6 @@
"items": {
"type": "object"
}
},
"ipAddresses": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
Expand All @@ -337,28 +322,21 @@
"type": "object",
"properties": {
"ids": {
"maximum": 200,
"minimum": 1,
"type": "array",
"format": "String",
"example": "[rrn:xxx:xx:xx-xx-x:xxx:xxx:x-xxxx]",
"items": {
"maximum": 200,
"minimum": 1,
"type": "string",
"format": "String",
"example": "[rrn:xxx:xx:xx-xx-x:xxx:xxx:x-xxxx]"
"example": "rrn:xxx:xx:xx-xx-x:xxx:xxx:x-xxxx"
}
}
},
"description": "Request object for id translation"
},
"AssetRequest": {
"required": [
"alertIds",
"assetId",
"attackPathIds",
"prismaCloudFindingsOnly",
"type"
],
"type": "object",
Expand Down Expand Up @@ -397,7 +375,9 @@
"vulnerabilities_group_by_type",
"asset_cwp_vulns",
"app_contexts",
"attributes"
"attributes",
"data_security",
"data_security_summary"
]
},
"findingType": {
Expand Down Expand Up @@ -673,37 +653,10 @@
"$ref": "#/components/schemas/AssetWrapper"
},
"errors": {
"required": [
"locations",
"message",
"path",
"pathAsString"
],
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "object"
}
},
"locations": {
"type": "array",
"items": {
"type": "object"
}
},
"extensions": {
"$ref": "#/components/schemas/GraphQLErrorExtensions"
},
"pathAsString": {
"type": "string"
}
},
"description": "Error Object."
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphQLError"
}
}
},
"description": "Asset object"
Expand Down Expand Up @@ -939,6 +892,39 @@
}
}
},
"GraphQLError": {
"required": [
"locations",
"message",
"path",
"pathAsString"
],
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "object"
}
},
"locations": {
"type": "array",
"items": {
"type": "object"
}
},
"extensions": {
"$ref": "#/components/schemas/GraphQLErrorExtensions"
},
"pathAsString": {
"type": "string"
}
},
"description": "Error Object."
},
"GraphQLErrorDebugInfo": {
"required": [
"subquery",
Expand Down Expand Up @@ -1138,12 +1124,6 @@
"hasExtFindingRiskFactors": {
"type": "boolean"
},
"assetClassId": {
"type": "string"
},
"assetClass": {
"type": "string"
},
"alertsCount": {
"type": "array",
"items": {
Expand All @@ -1163,6 +1143,9 @@
"assetCategory": {
"type": "string"
},
"dataSecurityServiceProviderId": {
"type": "string"
},
"problem": {
"type": "array",
"items": {
Expand Down Expand Up @@ -1448,6 +1431,12 @@
},
"trueInternetExposure": {
"type": "string"
},
"dataSecurity": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"description": "Asset Domain Service Object type."
Expand Down
Loading