SecurityAssessmentSummary

class oci.data_safe.models.SecurityAssessmentSummary(**kwargs)

Bases: object

The summary of a security assessment.

Attributes:

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

LIFECYCLE_STATE_SUCCEEDED

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary.

TARGET_TYPE_TARGET_DATABASE

A constant which can be used with the target_type property of a SecurityAssessmentSummary.

TARGET_TYPE_TARGET_DATABASE_GROUP

A constant which can be used with the target_type property of a SecurityAssessmentSummary.

TRIGGERED_BY_SYSTEM

A constant which can be used with the triggered_by property of a SecurityAssessmentSummary.

TRIGGERED_BY_USER

A constant which can be used with the triggered_by property of a SecurityAssessmentSummary.

TYPE_COMPARTMENT

A constant which can be used with the type property of a SecurityAssessmentSummary.

TYPE_LATEST

A constant which can be used with the type property of a SecurityAssessmentSummary.

TYPE_SAVED

A constant which can be used with the type property of a SecurityAssessmentSummary.

TYPE_SAVE_SCHEDULE

A constant which can be used with the type property of a SecurityAssessmentSummary.

TYPE_TEMPLATE

A constant which can be used with the type property of a SecurityAssessmentSummary.

TYPE_TEMPLATE_BASELINE

A constant which can be used with the type property of a SecurityAssessmentSummary.

baseline_assessment_id

Gets the baseline_assessment_id of this SecurityAssessmentSummary.

compartment_id

[Required] Gets the compartment_id of this SecurityAssessmentSummary.

defined_tags

Gets the defined_tags of this SecurityAssessmentSummary.

description

Gets the description of this SecurityAssessmentSummary.

display_name

[Required] Gets the display_name of this SecurityAssessmentSummary.

freeform_tags

Gets the freeform_tags of this SecurityAssessmentSummary.

id

[Required] Gets the id of this SecurityAssessmentSummary.

ignored_assessment_ids

Gets the ignored_assessment_ids of this SecurityAssessmentSummary.

ignored_target_ids

Gets the ignored_target_ids of this SecurityAssessmentSummary.

is_baseline

Gets the is_baseline of this SecurityAssessmentSummary.

is_deviated_from_baseline

Gets the is_deviated_from_baseline of this SecurityAssessmentSummary.

last_compared_baseline_id

Gets the last_compared_baseline_id of this SecurityAssessmentSummary.

lifecycle_details

Gets the lifecycle_details of this SecurityAssessmentSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this SecurityAssessmentSummary.

link

Gets the link of this SecurityAssessmentSummary.

schedule

Gets the schedule of this SecurityAssessmentSummary.

schedule_security_assessment_id

Gets the schedule_security_assessment_id of this SecurityAssessmentSummary.

statistics

Gets the statistics of this SecurityAssessmentSummary.

target_database_group_id

Gets the target_database_group_id of this SecurityAssessmentSummary.

target_ids

[Required] Gets the target_ids of this SecurityAssessmentSummary.

target_type

Gets the target_type of this SecurityAssessmentSummary.

template_assessment_id

Gets the template_assessment_id of this SecurityAssessmentSummary.

time_created

[Required] Gets the time_created of this SecurityAssessmentSummary.

time_last_assessed

Gets the time_last_assessed of this SecurityAssessmentSummary.

time_updated

[Required] Gets the time_updated of this SecurityAssessmentSummary.

triggered_by

Gets the triggered_by of this SecurityAssessmentSummary.

type

[Required] Gets the type of this SecurityAssessmentSummary.

Methods:

__init__(**kwargs)

Initializes a new SecurityAssessmentSummary object with values from keyword arguments.

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SecurityAssessmentSummary. 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 SecurityAssessmentSummary. 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 SecurityAssessmentSummary. 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 SecurityAssessmentSummary. This constant has a value of “SYSTEM”

TRIGGERED_BY_USER = 'USER'

A constant which can be used with the triggered_by property of a SecurityAssessmentSummary. This constant has a value of “USER”

TYPE_COMPARTMENT = 'COMPARTMENT'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “COMPARTMENT”

TYPE_LATEST = 'LATEST'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “LATEST”

TYPE_SAVED = 'SAVED'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “SAVED”

TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “SAVE_SCHEDULE”

TYPE_TEMPLATE = 'TEMPLATE'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “TEMPLATE”

TYPE_TEMPLATE_BASELINE = 'TEMPLATE_BASELINE'

A constant which can be used with the type property of a SecurityAssessmentSummary. This constant has a value of “TEMPLATE_BASELINE”

__init__(**kwargs)

Initializes a new SecurityAssessmentSummary 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 SecurityAssessmentSummary.

  • target_database_group_id (str) – The value to assign to the target_database_group_id property of this SecurityAssessmentSummary.

  • target_type (str) – The value to assign to the target_type property of this SecurityAssessmentSummary. 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’.

  • description (str) – The value to assign to the description property of this SecurityAssessmentSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

  • time_created (datetime) – The value to assign to the time_created property of this SecurityAssessmentSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this SecurityAssessmentSummary.

  • time_last_assessed (datetime) – The value to assign to the time_last_assessed property of this SecurityAssessmentSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this SecurityAssessmentSummary.

  • display_name (str) – The value to assign to the display_name property of this SecurityAssessmentSummary.

  • target_ids (list[str]) – The value to assign to the target_ids property of this SecurityAssessmentSummary.

  • ignored_target_ids (list[object]) – The value to assign to the ignored_target_ids property of this SecurityAssessmentSummary.

  • ignored_assessment_ids (list[object]) – The value to assign to the ignored_assessment_ids property of this SecurityAssessmentSummary.

  • is_baseline (bool) – The value to assign to the is_baseline property of this SecurityAssessmentSummary.

  • is_deviated_from_baseline (bool) – The value to assign to the is_deviated_from_baseline property of this SecurityAssessmentSummary.

  • last_compared_baseline_id (str) – The value to assign to the last_compared_baseline_id property of this SecurityAssessmentSummary.

  • schedule_security_assessment_id (str) – The value to assign to the schedule_security_assessment_id property of this SecurityAssessmentSummary.

  • template_assessment_id (str) – The value to assign to the template_assessment_id property of this SecurityAssessmentSummary.

  • baseline_assessment_id (str) – The value to assign to the baseline_assessment_id property of this SecurityAssessmentSummary.

  • schedule (str) – The value to assign to the schedule property of this SecurityAssessmentSummary.

  • triggered_by (str) – The value to assign to the triggered_by property of this SecurityAssessmentSummary. 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’.

  • link (str) – The value to assign to the link property of this SecurityAssessmentSummary.

  • type (str) – The value to assign to the type property of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecurityAssessmentSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecurityAssessmentSummary.

property baseline_assessment_id

Gets the baseline_assessment_id of this SecurityAssessmentSummary. The OCID of the security assessment of type TEMPLATE_BASELINE.

Returns

The baseline_assessment_id of this SecurityAssessmentSummary.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this SecurityAssessmentSummary. The OCID of the compartment that contains the security assessment.

Returns

The compartment_id of this SecurityAssessmentSummary.

Return type

str

property defined_tags

Gets the defined_tags of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this SecurityAssessmentSummary. The description of the security assessment.

Returns

The description of this SecurityAssessmentSummary.

Return type

str

property display_name

[Required] Gets the display_name of this SecurityAssessmentSummary. The display name of the security assessment.

Returns

The display_name of this SecurityAssessmentSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this SecurityAssessmentSummary. The OCID of the security assessment.

Returns

The id of this SecurityAssessmentSummary.

Return type

str

property ignored_assessment_ids

Gets the ignored_assessment_ids of this SecurityAssessmentSummary. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }

Returns

The ignored_assessment_ids of this SecurityAssessmentSummary.

Return type

list[object]

property ignored_target_ids

Gets the ignored_target_ids of this SecurityAssessmentSummary. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }

Returns

The ignored_target_ids of this SecurityAssessmentSummary.

Return type

list[object]

property is_baseline

Gets the is_baseline of this SecurityAssessmentSummary. Indicates whether or not the assessment is a baseline assessment. This applied to saved security assessments only.

Returns

The is_baseline of this SecurityAssessmentSummary.

Return type

bool

property is_deviated_from_baseline

Gets the is_deviated_from_baseline of this SecurityAssessmentSummary. Indicates whether or not the security assessment deviates from the baseline.

Returns

The is_deviated_from_baseline of this SecurityAssessmentSummary.

Return type

bool

property last_compared_baseline_id

Gets the last_compared_baseline_id of this SecurityAssessmentSummary. The OCID of the baseline against which the latest assessment was compared.

Returns

The last_compared_baseline_id of this SecurityAssessmentSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this SecurityAssessmentSummary. Details about the current state of the security assessment.

Returns

The lifecycle_details of this SecurityAssessmentSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

Return type

str

Gets the link of this SecurityAssessmentSummary. The summary of findings for the security assessment.

Returns

The link of this SecurityAssessmentSummary.

Return type

str

property schedule

Gets the schedule of this SecurityAssessmentSummary. Schedule of the assessment that runs 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 SecurityAssessmentSummary.

Return type

str

property schedule_security_assessment_id

Gets the schedule_security_assessment_id of this SecurityAssessmentSummary. The OCID of the security assessment that created this scheduled save assessment.

Returns

The schedule_security_assessment_id of this SecurityAssessmentSummary.

Return type

str

property statistics

Gets the statistics of this SecurityAssessmentSummary.

Returns

The statistics of this SecurityAssessmentSummary.

Return type

oci.data_safe.models.SecurityAssessmentStatistics

property target_database_group_id

Gets the target_database_group_id of this SecurityAssessmentSummary. The OCID of target database group.

Returns

The target_database_group_id of this SecurityAssessmentSummary.

Return type

str

property target_ids

[Required] Gets the target_ids of this SecurityAssessmentSummary. Array of database target OCIDs.

Returns

The target_ids of this SecurityAssessmentSummary.

Return type

list[str]

property target_type

Gets the target_type of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

Return type

str

property template_assessment_id

Gets the template_assessment_id of this SecurityAssessmentSummary. The OCID of the security assessment of type TEMPLATE.

Returns

The template_assessment_id of this SecurityAssessmentSummary.

Return type

str

property time_created

[Required] Gets the time_created of this SecurityAssessmentSummary. The date and time the security assessment was created, in the format defined by RFC3339.

Returns

The time_created of this SecurityAssessmentSummary.

Return type

datetime

property time_last_assessed

Gets the time_last_assessed of this SecurityAssessmentSummary. The date and time the security assessment was last executed, in the format defined by RFC3339.

Returns

The time_last_assessed of this SecurityAssessmentSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this SecurityAssessmentSummary. The date and time the security assessment was last updated, in the format defined by RFC3339.

Returns

The time_updated of this SecurityAssessmentSummary.

Return type

datetime

property triggered_by

Gets the triggered_by of this SecurityAssessmentSummary. 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 SecurityAssessmentSummary.

Return type

str

property type

[Required] Gets the type of this SecurityAssessmentSummary. The type of the security assessment. Possible values 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. TEMPLATE: The security assessment contains the checks that the user would like to run. It is user defined. TEMPLATE_BASELINE: The security assessment contains the checks that the user would like to run, together with the max allowed severity. The max allowed severity can be defined by the user. 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 SecurityAssessmentSummary.

Return type

str