/** * Data Safe API * APIs for using Oracle Data Safe. * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * A security assessment that provides an overall insight into your database security posture. * The security assessment results are based on the analysis of your database configurations, * user accounts, and security controls. For more information, see [Security Assessment Overview](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/security-assessment-overview.html). * */ export interface SecurityAssessment { /** * The OCID of the security assessment. */ "id": string; /** * The date and time the security assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ "timeCreated": Date; /** * The date and time the security assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ "timeUpdated": Date; /** * The date and time the security assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ "timeLastAssessed"?: Date; /** * The OCID of the compartment that contains the security assessment. */ "compartmentId": string; /** * The display name of the security assessment. */ "displayName": string; /** * Array of database target OCIDs. */ "targetIds": Array; /** * List containing maps as values. * Example: {@code {\"Operations\": [ {\"CostCenter\": \"42\"} ] }} * */ "ignoredTargets"?: Array; /** * List containing maps as values. * Example: {@code {\"Operations\": [ {\"CostCenter\": \"42\"} ] }} * */ "ignoredAssessmentIds"?: Array; /** * The version of the target database. */ "targetVersion"?: string; /** * The ocid of a security assessment which is of type TEMPLATE, this will be null or empty when type is TEMPLATE. */ "templateAssessmentId"?: string; /** * The ocid of a security assessment which is of type TEMPLATE_BASELINE, this will be null or empty when type is TEMPLATE_BASELINE. */ "baselineAssessmentId"?: string; /** * Indicates whether or not the security assessment is set as a baseline. This is applicable only for saved security assessments. */ "isBaseline"?: boolean; /** * Indicates if the assessment has deviated from the baseline. */ "isDeviatedFromBaseline"?: boolean; /** * The OCID of the baseline against which the latest security assessment was compared. */ "lastComparedBaselineId"?: string; /** * The current state of the security assessment. */ "lifecycleState": model.SecurityAssessmentLifecycleState; /** * Details about the current state of the security assessment. */ "lifecycleDetails"?: string; /** * The OCID of the security assessment that is responsible for creating this scheduled save assessment. */ "scheduleSecurityAssessmentId"?: string; /** * Indicates whether the security assessment was created by system or by a user. */ "triggeredBy"?: SecurityAssessment.TriggeredBy; /** * The description of the security assessment. */ "description"?: string; /** * Indicates whether the assessment is scheduled to run. */ "isAssessmentScheduled"?: boolean; /** * The OCID of the target database group that the group assessment is created for. */ "targetDatabaseGroupId"?: string; /** * Indicates whether the security assessment is for a target database or a target database group. */ "targetType"?: model.SecurityAssessmentTargetType; /** * The security checks to be evaluated for type template. */ "checks"?: Array; /** * Schedule to save the assessment periodically in the specified format: * ; *

Allowed version strings - \"v1\" * v1's version specific schedule - * Each of the above fields potentially introduce constraints. A workrequest is created only * when clock time satisfies all the constraints. Constraints introduced: * 1. seconds = (So, the allowed range for is [0, 59]) * 2. minutes = (So, the allowed range for is [0, 59]) * 3. hours = (So, the allowed range for is [0, 23]) * can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) * 4. No constraint introduced when it is '*'. When not, day of week must equal the given value * can be either '*' (without quotes or a number between 1 and 28) * 5. No constraint introduced when it is '*'. When not, day of month must equal the given value * */ "schedule"?: string; /** * The summary of findings for the security assessment * */ "link"?: string; /** * The type of this security assessment. The possible types are: *

LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. * SAVED: A saved security assessment. LATEST assessments are always saved in order to maintain the history of runs. A SAVED assessment is also generated by a 'refresh' action (triggered by the user). * SAVE_SCHEDULE: The schedule for periodic saves of LATEST assessments. * COMPARTMENT: An automatically managed assessment type that stores all details of targets in one compartment. * This type keeps an up-to-date assessment of all database risks in one compartment. It is automatically updated when * the latest assessment or refresh action is executed. It is also automatically updated when a target is deleted or move to a different compartment. * */ "type": SecurityAssessment.Type; "statistics"?: model.SecurityAssessmentStatistics; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) *

Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}} * */ "systemTags"?: { [key: string]: { [key: string]: any; }; }; } export declare namespace SecurityAssessment { enum TriggeredBy { User = "USER", System = "SYSTEM", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum Type { Latest = "LATEST", Saved = "SAVED", SaveSchedule = "SAVE_SCHEDULE", Compartment = "COMPARTMENT", Template = "TEMPLATE", TemplateBaseline = "TEMPLATE_BASELINE", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: SecurityAssessment): object; function getDeserializedJsonObj(obj: SecurityAssessment): object; }