Skip to content

LAB-2585: [Data Gateway] Open API Spec for CSPM Assessment Data Retrieval #194

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

Merged
pr0uxx merged 3 commits into from
Jul 17, 2026
Merged

LAB-2585: [Data Gateway] Open API Spec for CSPM Assessment Data Retrieval #194

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c702f22
LAB-2585: [Data Gateway] Open API Spec for CSPM Assessment Data Retri…
Loop-infinity Jul 15, 2026
62443ac
Potential fix for pull request finding
Loop-infinity Jul 16, 2026
161859a
LAB-2581: Update CSPM Assessment Open api spec
Loop-infinity Jul 17, 2026
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
169 changes: 168 additions & 1 deletion specs/Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5533,7 +5533,7 @@
],
"properties": {
"correlationId": {
"$ref": "#/components/schemas/Uuid",
"$ref": "#/components/schemas/Uuid",
"description": "Matches ID from whatever is being audited."
},
"name": {
Expand Down Expand Up @@ -10068,6 +10068,173 @@
"summary": "Submit CSPM Policy Assessment V1"
}
},
"/Api/V1/ArchitectureReport/CspmPolicyAssessment/Correlation/{correlationId}/Data": {
"get": {
"summary": "Retrieve CSPM Policy Assessment V1 by Correlation ID",
"description": "Retrieves the stored CSPM policy assessment for the specified correlation ID in the authenticated tenant.\n\nThis endpoint requires the `ArchitectureReport.Read`, `ArchitectureReport.Read.All`, `ArchitectureReport.ReadWrite`, or `ArchitectureReport.ReadWrite.All` scope (permission).",
"operationId": "/Api/V1/ArchitectureReport/CspmPolicyAssessment/Correlation/:correlationId/Data/Get",
"parameters": [
{
"$ref": "#/components/parameters/correlationId"
}
],
"responses": {
"200": {
"description": "The CSPM policy assessment data for the specified correlation ID.",
"content": {
"application/json": {
"examples": {
"CSPM Policy Assessment V1": {
"description": "Sample stored CSPM policy assessment result retrieved by correlation record ID.",
"summary": "CSPM Policy Assessment Details",
"value": {
"correlation": {
"auditTenantAccount": "user@example.com",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdAt": "2023-11-19T10:00:00.000Z",
"reportTenantAccount": "user@example.com",
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2023-11-19T10:05:00.000Z"
},
"data": {
"reportCreatedDate": "2026-06-26T11:00:00.000Z",
"reportUpdatedDate": "2026-06-26T11:00:00.000Z",
"policyList": {
"a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"name": "Require MFA for all users",
"categoryList": [
"Conditional Access"
],
"coverageStatus": "partial",
"coverageMetricsRaw": {
"covered": 80,
"partial": 15,
"noCover": 5
},
"coverageMetricsNormalized": {
"covered": 80,
"partial": 15,
"noCover": 5
}
}
}
},
"schemaVersion": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/CspmPolicyAssessmentV1"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"tags": [
"Architecture Reporting"
]
}
},
"/Api/V1/ArchitectureReport/CspmPolicyAssessment/Correlation/{correlationId}/Tenant/{tenantId}/Data": {
"get": {
"summary": "Retrieve CSPM Policy Assessment V1 by Correlation ID and Tenant ID",
"description": "Retrieves the stored CSPM policy assessment for the specified correlation ID in the specified tenant.\n\nThis endpoint requires the `ArchitectureReport.Read.All`, `ArchitectureReport.ReadWrite.All` scope (permission). This endpoint is also only accessible from the `SHI` and `SHI Lab` tenants. End user access is restricted.",
"operationId": "/Api/V1/ArchitectureReport/CspmPolicyAssessment/Correlation/:correlationId/Tenant/:tenantId/Data/Get",
"parameters": [
{
"$ref": "#/components/parameters/correlationId"
},
{
"$ref": "#/components/parameters/tenantId"
}
],
"responses": {
"200": {
"description": "The CSPM policy assessment data for the specified correlation ID and tenant ID.",
"content": {
"application/json": {
"examples": {
"CSPM Policy Assessment V1": {
"description": "Sample stored CSPM policy assessment result retrieved by correlation record ID and tenant ID.",
"summary": "CSPM Policy Assessment Details",
"value": {
"correlation": {
"auditTenantAccount": "user@example.com",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdAt": "2023-11-19T10:00:00.000Z",
"reportTenantAccount": "user@example.com",
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2023-11-19T10:05:00.000Z"
},
"data": {
"reportCreatedDate": "2026-06-26T11:00:00.000Z",
"reportUpdatedDate": "2026-06-26T11:00:00.000Z",
"policyList": {
"a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"name": "Require MFA for all users",
"categoryList": [
"Conditional Access"
],
"coverageStatus": "partial",
"coverageMetricsRaw": {
"covered": 80,
"partial": 15,
"noCover": 5
},
"coverageMetricsNormalized": {
"covered": 80,
"partial": 15,
"noCover": 5
}
}
}
},
"schemaVersion": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/CspmPolicyAssessmentV1"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
Comment thread
Copilot marked this conversation as resolved.
},
"tags": [
"Architecture Reporting"
]
}
},
"/Api/CloudMatrix/Dashboard": {
"get": {
"description": "Retrieves the list of cloud matrix correlation records on the tenant provided inside the token. Can use filters targeting creation date to limit results. Cloud matrix records store the metadata for a specific cloud matrix correlation.\n\nThis endpoint requires the `CloudMatrix.Read`, `CloudMatrix.Read.Del`, `CloudMatrix.Read.All`, `CloudMatrix.ReadWrite`, or `CloudMatrix.ReadWrite.All` scope (permission).",
Expand Down