SecurityAssessment¶
- class oci.data_safe.models.SecurityAssessment(**kwargs)¶
Bases:
objectA 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.
Attributes:
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the lifecycle_state property of a SecurityAssessment.
A constant which can be used with the target_type property of a SecurityAssessment.
A constant which can be used with the target_type property of a SecurityAssessment.
A constant which can be used with the triggered_by property of a SecurityAssessment.
A constant which can be used with the triggered_by property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
A constant which can be used with the type property of a SecurityAssessment.
Gets the baseline_assessment_id of this SecurityAssessment.
Gets the checks of this SecurityAssessment.
[Required] Gets the compartment_id of this SecurityAssessment.
Gets the defined_tags of this SecurityAssessment.
Gets the description of this SecurityAssessment.
[Required] Gets the display_name of this SecurityAssessment.
Gets the freeform_tags of this SecurityAssessment.
[Required] Gets the id of this SecurityAssessment.
Gets the ignored_assessment_ids of this SecurityAssessment.
Gets the ignored_targets of this SecurityAssessment.
Gets the is_assessment_scheduled of this SecurityAssessment.
Gets the is_baseline of this SecurityAssessment.
Gets the is_deviated_from_baseline of this SecurityAssessment.
Gets the last_compared_baseline_id of this SecurityAssessment.
Gets the lifecycle_details of this SecurityAssessment.
[Required] Gets the lifecycle_state of this SecurityAssessment.
Gets the link of this SecurityAssessment.
Gets the schedule of this SecurityAssessment.
Gets the schedule_security_assessment_id of this SecurityAssessment.
Gets the statistics of this SecurityAssessment.
Gets the system_tags of this SecurityAssessment.
Gets the target_database_group_id of this SecurityAssessment.
[Required] Gets the target_ids of this SecurityAssessment.
Gets the target_type of this SecurityAssessment.
Gets the target_version of this SecurityAssessment.
Gets the template_assessment_id of this SecurityAssessment.
[Required] Gets the time_created of this SecurityAssessment.
Gets the time_last_assessed of this SecurityAssessment.
[Required] Gets the time_updated of this SecurityAssessment.
Gets the triggered_by of this SecurityAssessment.
[Required] Gets the type of this SecurityAssessment.
Methods:
__init__(**kwargs)Initializes a new SecurityAssessment object with values from keyword arguments.
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “FAILED”
- LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “SUCCEEDED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a SecurityAssessment. This constant has a value of “UPDATING”
- TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶
A constant which can be used with the target_type property of a SecurityAssessment. This constant has a value of “TARGET_DATABASE”
- TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'¶
A constant which can be used with the target_type property of a SecurityAssessment. This constant has a value of “TARGET_DATABASE_GROUP”
- TRIGGERED_BY_SYSTEM = 'SYSTEM'¶
A constant which can be used with the triggered_by property of a SecurityAssessment. This constant has a value of “SYSTEM”
- TRIGGERED_BY_USER = 'USER'¶
A constant which can be used with the triggered_by property of a SecurityAssessment. This constant has a value of “USER”
- TYPE_COMPARTMENT = 'COMPARTMENT'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “COMPARTMENT”
- TYPE_LATEST = 'LATEST'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “LATEST”
- TYPE_SAVED = 'SAVED'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “SAVED”
- TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “SAVE_SCHEDULE”
- TYPE_TEMPLATE = 'TEMPLATE'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “TEMPLATE”
- TYPE_TEMPLATE_BASELINE = 'TEMPLATE_BASELINE'¶
A constant which can be used with the type property of a SecurityAssessment. This constant has a value of “TEMPLATE_BASELINE”
- __init__(**kwargs)¶
Initializes a new SecurityAssessment object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this SecurityAssessment.
time_created (datetime) – The value to assign to the time_created property of this SecurityAssessment.
time_updated (datetime) – The value to assign to the time_updated property of this SecurityAssessment.
time_last_assessed (datetime) – The value to assign to the time_last_assessed property of this SecurityAssessment.
compartment_id (str) – The value to assign to the compartment_id property of this SecurityAssessment.
display_name (str) – The value to assign to the display_name property of this SecurityAssessment.
target_ids (list[str]) – The value to assign to the target_ids property of this SecurityAssessment.
ignored_targets (list[object]) – The value to assign to the ignored_targets property of this SecurityAssessment.
ignored_assessment_ids (list[object]) – The value to assign to the ignored_assessment_ids property of this SecurityAssessment.
target_version (str) – The value to assign to the target_version property of this SecurityAssessment.
template_assessment_id (str) – The value to assign to the template_assessment_id property of this SecurityAssessment.
baseline_assessment_id (str) – The value to assign to the baseline_assessment_id property of this SecurityAssessment.
is_baseline (bool) – The value to assign to the is_baseline property of this SecurityAssessment.
is_deviated_from_baseline (bool) – The value to assign to the is_deviated_from_baseline property of this SecurityAssessment.
last_compared_baseline_id (str) – The value to assign to the last_compared_baseline_id property of this SecurityAssessment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityAssessment. Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SecurityAssessment.
schedule_security_assessment_id (str) – The value to assign to the schedule_security_assessment_id property of this SecurityAssessment.
triggered_by (str) – The value to assign to the triggered_by property of this SecurityAssessment. Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this SecurityAssessment.
is_assessment_scheduled (bool) – The value to assign to the is_assessment_scheduled property of this SecurityAssessment.
target_database_group_id (str) – The value to assign to the target_database_group_id property of this SecurityAssessment.
target_type (str) – The value to assign to the target_type property of this SecurityAssessment. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
checks (list[oci.data_safe.models.Check]) – The value to assign to the checks property of this SecurityAssessment.
schedule (str) – The value to assign to the schedule property of this SecurityAssessment.
link (str) – The value to assign to the link property of this SecurityAssessment.
type (str) – The value to assign to the type property of this SecurityAssessment. Allowed values for this property are: “LATEST”, “SAVED”, “SAVE_SCHEDULE”, “COMPARTMENT”, “TEMPLATE”, “TEMPLATE_BASELINE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
statistics (oci.data_safe.models.SecurityAssessmentStatistics) – The value to assign to the statistics property of this SecurityAssessment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecurityAssessment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecurityAssessment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecurityAssessment.
- property baseline_assessment_id¶
Gets the baseline_assessment_id of this SecurityAssessment. The ocid of a security assessment which is of type TEMPLATE_BASELINE, this will be null or empty when type is TEMPLATE_BASELINE.
- Returns
The baseline_assessment_id of this SecurityAssessment.
- Return type
str
- property checks¶
Gets the checks of this SecurityAssessment. The security checks to be evaluated for type template.
- Returns
The checks of this SecurityAssessment.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this SecurityAssessment. The OCID of the compartment that contains the security assessment.
- Returns
The compartment_id of this SecurityAssessment.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this SecurityAssessment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this SecurityAssessment.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this SecurityAssessment. The description of the security assessment.
- Returns
The description of this SecurityAssessment.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this SecurityAssessment. The display name of the security assessment.
- Returns
The display_name of this SecurityAssessment.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this SecurityAssessment. 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
Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this SecurityAssessment.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this SecurityAssessment. The OCID of the security assessment.
- Returns
The id of this SecurityAssessment.
- Return type
str
- property ignored_assessment_ids¶
Gets the ignored_assessment_ids of this SecurityAssessment. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }
- Returns
The ignored_assessment_ids of this SecurityAssessment.
- Return type
list[object]
- property ignored_targets¶
Gets the ignored_targets of this SecurityAssessment. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }
- Returns
The ignored_targets of this SecurityAssessment.
- Return type
list[object]
- property is_assessment_scheduled¶
Gets the is_assessment_scheduled of this SecurityAssessment. Indicates whether the assessment is scheduled to run.
- Returns
The is_assessment_scheduled of this SecurityAssessment.
- Return type
bool
- property is_baseline¶
Gets the is_baseline of this SecurityAssessment. Indicates whether or not the security assessment is set as a baseline. This is applicable only for saved security assessments.
- Returns
The is_baseline of this SecurityAssessment.
- Return type
bool
- property is_deviated_from_baseline¶
Gets the is_deviated_from_baseline of this SecurityAssessment. Indicates if the assessment has deviated from the baseline.
- Returns
The is_deviated_from_baseline of this SecurityAssessment.
- Return type
bool
- property last_compared_baseline_id¶
Gets the last_compared_baseline_id of this SecurityAssessment. The OCID of the baseline against which the latest security assessment was compared.
- Returns
The last_compared_baseline_id of this SecurityAssessment.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this SecurityAssessment. Details about the current state of the security assessment.
- Returns
The lifecycle_details of this SecurityAssessment.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this SecurityAssessment. The current state of the security assessment.
Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this SecurityAssessment.
- Return type
str
- property link¶
Gets the link of this SecurityAssessment. The summary of findings for the security assessment
- Returns
The link of this SecurityAssessment.
- Return type
str
- property schedule¶
Gets the schedule of this SecurityAssessment. Schedule to save the assessment periodically in the specified format: <version-string>;<version-specific-schedule>
Allowed version strings - “v1” v1’s version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> 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 <day-of-month> 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
- Returns
The schedule of this SecurityAssessment.
- Return type
str
- property schedule_security_assessment_id¶
Gets the schedule_security_assessment_id of this SecurityAssessment. The OCID of the security assessment that is responsible for creating this scheduled save assessment.
- Returns
The schedule_security_assessment_id of this SecurityAssessment.
- Return type
str
- property statistics¶
Gets the statistics of this SecurityAssessment.
- Returns
The statistics of this SecurityAssessment.
- Return type
- property system_tags¶
Gets the system_tags of this SecurityAssessment. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this SecurityAssessment.
- Return type
dict(str, dict(str, object))
- property target_database_group_id¶
Gets the target_database_group_id of this SecurityAssessment. The OCID of the target database group that the group assessment is created for.
- Returns
The target_database_group_id of this SecurityAssessment.
- Return type
str
- property target_ids¶
[Required] Gets the target_ids of this SecurityAssessment. Array of database target OCIDs.
- Returns
The target_ids of this SecurityAssessment.
- Return type
list[str]
- property target_type¶
Gets the target_type of this SecurityAssessment. Indicates whether the security assessment is for a target database or a target database group.
Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The target_type of this SecurityAssessment.
- Return type
str
- property target_version¶
Gets the target_version of this SecurityAssessment. The version of the target database.
- Returns
The target_version of this SecurityAssessment.
- Return type
str
- property template_assessment_id¶
Gets the template_assessment_id of this SecurityAssessment. The ocid of a security assessment which is of type TEMPLATE, this will be null or empty when type is TEMPLATE.
- Returns
The template_assessment_id of this SecurityAssessment.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this SecurityAssessment. The date and time the security assessment was created, in the format defined by RFC3339.
- Returns
The time_created of this SecurityAssessment.
- Return type
datetime
- property time_last_assessed¶
Gets the time_last_assessed of this SecurityAssessment. The date and time the security assessment was last executed, in the format defined by RFC3339.
- Returns
The time_last_assessed of this SecurityAssessment.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this SecurityAssessment. The date and time the security assessment was last updated, in the format defined by RFC3339.
- Returns
The time_updated of this SecurityAssessment.
- Return type
datetime
- property triggered_by¶
Gets the triggered_by of this SecurityAssessment. Indicates whether the security assessment was created by system or by a user.
Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The triggered_by of this SecurityAssessment.
- Return type
str
- property type¶
[Required] Gets the type of this SecurityAssessment. 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.
Allowed values for this property are: “LATEST”, “SAVED”, “SAVE_SCHEDULE”, “COMPARTMENT”, “TEMPLATE”, “TEMPLATE_BASELINE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this SecurityAssessment.
- Return type
str