AssessedFramework

Framework assessed and their findings.

JSON representation
{
  "framework": {
    object (Framework)
  },
  "findings": [
    {
      object (AssessmentFinding)
    }
  ],
  "scoreCard": {
    object (ScoreCard)
  },
  "skipped": boolean,
  "skippedReason": string
}
Fields
framework

object (Framework)

Required. The framework that was assessed.

findings[]

object (AssessmentFinding)

Required. A list of every Finding found during the assessment.

scoreCard

object (ScoreCard)

Optional. Score card associated with the report.

skipped

boolean

Optional. Whether the framework was skipped during assessment.

skippedReason

string

Optional. Reason for skipping the framework during assessment.

AssessmentFinding

Details of an Assessment Finding.

JSON representation
{
  "id": string,
  "assessedFrameworkId": string,
  "adcMetadata": {
    object (FindingADCMetadata)
  },
  "findingType": enum (Type),
  "severity": enum (Severity),
  "assessedAsset": {
    object (AssetDetails)
  },
  "assessedFramework": {
    object (Framework)
  },
  "description": string,
  "findingsUri": string,
  "sccMetadata": {
    object (SCCMetadata)
  },

  // Union field next_step can be only one of the following:
  "remediationStep": {
    object (RemediationStep)
  }
  // End of list of possible types for union field next_step.

  // Union field additional_details can be only one of the following:
  "additionalNotes": string
  // End of list of possible types for union field additional_details.
}
Fields
id

string

Output only. The Finding ID.

assessedFrameworkId

string

Optional. The framework that was assessed.

adcMetadata

object (FindingADCMetadata)

Output only. Metadata related to the Application Design Center with the finding.

findingType

enum (Type)

Required. The type of the finding. Findings can be informational, warning, or error.

severity

enum (Severity)

Optional. The severity of the finding.

assessedAsset

object (AssetDetails)

Required. Details of the Cloud Asset Inventory asset that was assessed.

assessedFramework

object (Framework)

Optional. Details of the framework that was assessed.

description

string

Optional. Description of the finding.

findingsUri

string

Optional. Link to the findings, if persisted by the domain.

sccMetadata

object (SCCMetadata)

Output only. SCC related metadata for the finding.

Union field next_step. Next steps related to the findings. next_step can be only one of the following:
remediationStep

object (RemediationStep)

Optional. A description of the steps that users can take to fix the finding.

Union field additional_details. Additional details about the finding. additional_details can be only one of the following:
additionalNotes

string

Optional. A description of the additional details about finding.

RemediationStep

Remediation steps that can be taken to rectify the finding.

JSON representation
{
  "remediationSteps": [
    string
  ],
  "remediationDocumentationUrl": string,
  "note": string
}
Fields
remediationSteps[]

string

Required. A description of the steps that users can take to remediate the findings.

remediationDocumentationUrl

string

Optional. Remediation documentation URL.

note

string

Optional. Any other note related to the remediation.

FindingADCMetadata

Metadata related to the Application Design Center with the finding.

JSON representation
{
  "componentName": string
}
Fields
componentName

string

Output only. Component the finding belongs to.

AssetDetails

Details of a Cloud Asset Inventory asset that caused the finding.

JSON representation
{
  "assetId": string,
  "assetType": string
}
Fields
assetId

string

Required. Information about the Cloud Asset Inventory asset that the framework is assessed against. The full resource name of the asset in CAIS format.

For details about the format of the full resource name for each asset type, see Resource name format.

assetType

string

Optional. The type of Cloud Asset Inventory asset. For a list of asset types, see Supported asset types.

SCCMetadata

SCC metadata for the assessment finding.

JSON representation
{
  "findingClass": string,
  "findingType": string
}
Fields
findingClass

string

Optional. The SCC finding class. Also known as category.

findingType

string

Optional. The SCC finding type.