Class VulnerabilityAudit
A vulnerability audit associates the application dependencies of a project with their associated Vulnerabilities. Each Vulnerability is associated with a score (Common Vulnerability Scoring System V2 or V3). A vulnerable application dependency can be ignored based on the configuration of the vulnerability audit. maxObservedCvssV2Score, maxObservedCvssV3Score and vulnerableArtifactsCount do not take into account non-vulnerable application dependency.
Inherited Members
Namespace: Oci.AdmService.Models
Assembly: OCI.DotNetSDK.Adm.dll
Syntax
public class VulnerabilityAudit
Properties
BuildType
Declaration
[Required(ErrorMessage = "BuildType is required.")]
[JsonProperty(PropertyName = "buildType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VulnerabilityAudit.BuildTypeEnum? BuildType { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilityAudit.BuildTypeEnum? | The type of the build tool is restricted to only two values MAVEN or UNSET. Use UNSET when the list of application dependencies is not Maven-related or is a mix of Maven and other ecosystems. This option is soon to be deprecated. |
Remarks
Required
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The compartment Oracle Cloud identifier (OCID) of the vulnerability audit. |
Remarks
Required
Configuration
Declaration
[JsonProperty(PropertyName = "configuration")]
public VulnerabilityAuditConfiguration Configuration { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilityAuditConfiguration |
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the vulnerability audit. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The Oracle Cloud identifier (OCID) of the vulnerability audit. |
Remarks
Required
IsSuccess
Declaration
[JsonProperty(PropertyName = "isSuccess")]
public bool? IsSuccess { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if an audit succeeded according to the configuration. The value is |
KnowledgeBaseId
Declaration
[Required(ErrorMessage = "KnowledgeBaseId is required.")]
[JsonProperty(PropertyName = "knowledgeBaseId")]
public string KnowledgeBaseId { get; set; }
Property Value
Type | Description |
---|---|
string | The Oracle Cloud identifier (OCID) of the knowledge base. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VulnerabilityAudit.LifecycleDetailsEnum? LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilityAudit.LifecycleDetailsEnum? | Details on the lifecycle state. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VulnerabilityAudit.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilityAudit.LifecycleStateEnum? | The current lifecycle state of the vulnerability audit. |
Remarks
Required
MaxObservedCvssV2Score
Declaration
[JsonProperty(PropertyName = "maxObservedCvssV2Score")]
public float? MaxObservedCvssV2Score { get; set; }
Property Value
Type | Description |
---|---|
float? | Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies. |
MaxObservedCvssV2ScoreWithIgnored
Declaration
[JsonProperty(PropertyName = "maxObservedCvssV2ScoreWithIgnored")]
public float? MaxObservedCvssV2ScoreWithIgnored { get; set; }
Property Value
Type | Description |
---|---|
float? | Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones. |
MaxObservedCvssV3Score
Declaration
[JsonProperty(PropertyName = "maxObservedCvssV3Score")]
public float? MaxObservedCvssV3Score { get; set; }
Property Value
Type | Description |
---|---|
float? | Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies. |
MaxObservedCvssV3ScoreWithIgnored
Declaration
[JsonProperty(PropertyName = "maxObservedCvssV3ScoreWithIgnored")]
public float? MaxObservedCvssV3ScoreWithIgnored { get; set; }
Property Value
Type | Description |
---|---|
float? | Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones. |
MaxObservedSeverity
Declaration
[JsonProperty(PropertyName = "maxObservedSeverity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VulnerabilitySeverity? MaxObservedSeverity { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilitySeverity? | Maximum ADM Severity observed for non-ignored vulnerable application dependencies. |
MaxObservedSeverityWithIgnored
Declaration
[JsonProperty(PropertyName = "maxObservedSeverityWithIgnored")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VulnerabilitySeverity? MaxObservedSeverityWithIgnored { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilitySeverity? | Maximum ADM Severity observed for vulnerable application dependencies including ignored ones. |
Source
Declaration
[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
public VulnerabilityAuditSource Source { get; set; }
Property Value
Type | Description |
---|---|
VulnerabilityAuditSource |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The creation date and time of the vulnerability audit (formatted according to RFC3339). |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The update date and time of the vulnerability audit (formatted according to RFC3339). |
Remarks
Required
UsageData
Declaration
[JsonProperty(PropertyName = "usageData")]
public UsageDataDetails UsageData { get; set; }
Property Value
Type | Description |
---|---|
UsageDataDetails |
Vulnerabilities
Declaration
[Required(ErrorMessage = "Vulnerabilities is required.")]
[JsonProperty(PropertyName = "vulnerabilities")]
public List<Vulnerability> Vulnerabilities { get; set; }
Property Value
Type | Description |
---|---|
List<Vulnerability> | List of vulnerabilities found in the vulnerability audit. If a vulnerability affects multiple dependencies, the metadata returned here consists of audit-wide aggregates. |
Remarks
Required
VulnerableArtifactsCount
Declaration
[Required(ErrorMessage = "VulnerableArtifactsCount is required.")]
[JsonProperty(PropertyName = "vulnerableArtifactsCount")]
public int? VulnerableArtifactsCount { get; set; }
Property Value
Type | Description |
---|---|
int? | Count of non-ignored vulnerable application dependencies. |
Remarks
Required
VulnerableArtifactsCountWithIgnored
Declaration
[Required(ErrorMessage = "VulnerableArtifactsCountWithIgnored is required.")]
[JsonProperty(PropertyName = "vulnerableArtifactsCountWithIgnored")]
public int? VulnerableArtifactsCountWithIgnored { get; set; }
Property Value
Type | Description |
---|---|
int? | Count of all vulnerable application dependencies. |
Remarks
Required