AuditSpecification¶

class oci.data_safe.models.AuditSpecification(**kwargs)¶

Bases: object

Represents an audit policy relevant for the target database.The audit policy could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on relevant audit policies for the target database, refer to documentation.

Attributes

`AUDIT_POLICY_CATEGORY_ADMIN_USER_ACTIVITY`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_BASIC_ACTIVITY`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_COMPLIANCE_STANDARD`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_CUSTOM`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_ORACLE_PREDEFINED`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_SQL_FIREWALL_AUDITING`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`AUDIT_POLICY_CATEGORY_USER_ACTIVITY`	A constant which can be used with the audit_policy_category property of a AuditSpecification.
`ENABLED_ENTITIES_ALL_USERS`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLED_ENTITIES_DISABLED`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLED_ENTITIES_EXCLUDE_USERS`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLED_ENTITIES_INCLUDE_ROLES`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLED_ENTITIES_INCLUDE_USERS`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLED_ENTITIES_INCLUDE_USERS_ROLES`	A constant which can be used with the enabled_entities property of a AuditSpecification.
`ENABLE_STATUS_DISABLED`	A constant which can be used with the enable_status property of a AuditSpecification.
`ENABLE_STATUS_ENABLED`	A constant which can be used with the enable_status property of a AuditSpecification.
`ENABLE_STATUS_PARTIALLY_ENABLED`	A constant which can be used with the enable_status property of a AuditSpecification.
`audit_policy_category`	[Required] Gets the audit_policy_category of this AuditSpecification.
`audit_policy_name`	[Required] Gets the audit_policy_name of this AuditSpecification.
`database_policy_names`	[Required] Gets the database_policy_names of this AuditSpecification.
`enable_status`	[Required] Gets the enable_status of this AuditSpecification.
`enabled_entities`	[Required] Gets the enabled_entities of this AuditSpecification.
`is_created`	[Required] Gets the is_created of this AuditSpecification.
`is_enabled_for_all_users`	[Required] Gets the is_enabled_for_all_users of this AuditSpecification.
`is_seeded_in_data_safe`	[Required] Gets the is_seeded_in_data_safe of this AuditSpecification.
`is_seeded_in_target`	[Required] Gets the is_seeded_in_target of this AuditSpecification.
`is_view_only`	[Required] Gets the is_view_only of this AuditSpecification.
`partially_enabled_msg`	Gets the partially_enabled_msg of this AuditSpecification.

Methods

__init__(**kwargs) Initializes a new AuditSpecification object with values from keyword arguments.

AUDIT_POLICY_CATEGORY_ADMIN_USER_ACTIVITY = 'ADMIN_USER_ACTIVITY'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “ADMIN_USER_ACTIVITY”

AUDIT_POLICY_CATEGORY_BASIC_ACTIVITY = 'BASIC_ACTIVITY'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “BASIC_ACTIVITY”

AUDIT_POLICY_CATEGORY_COMPLIANCE_STANDARD = 'COMPLIANCE_STANDARD'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “COMPLIANCE_STANDARD”

AUDIT_POLICY_CATEGORY_CUSTOM = 'CUSTOM'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “CUSTOM”

AUDIT_POLICY_CATEGORY_ORACLE_PREDEFINED = 'ORACLE_PREDEFINED'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “ORACLE_PREDEFINED”

AUDIT_POLICY_CATEGORY_SQL_FIREWALL_AUDITING = 'SQL_FIREWALL_AUDITING'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “SQL_FIREWALL_AUDITING”

AUDIT_POLICY_CATEGORY_USER_ACTIVITY = 'USER_ACTIVITY'¶: A constant which can be used with the audit_policy_category property of a AuditSpecification. This constant has a value of “USER_ACTIVITY”

ENABLED_ENTITIES_ALL_USERS = 'ALL_USERS'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “ALL_USERS”

ENABLED_ENTITIES_DISABLED = 'DISABLED'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “DISABLED”

ENABLED_ENTITIES_EXCLUDE_USERS = 'EXCLUDE_USERS'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “EXCLUDE_USERS”

ENABLED_ENTITIES_INCLUDE_ROLES = 'INCLUDE_ROLES'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “INCLUDE_ROLES”

ENABLED_ENTITIES_INCLUDE_USERS = 'INCLUDE_USERS'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “INCLUDE_USERS”

ENABLED_ENTITIES_INCLUDE_USERS_ROLES = 'INCLUDE_USERS_ROLES'¶: A constant which can be used with the enabled_entities property of a AuditSpecification. This constant has a value of “INCLUDE_USERS_ROLES”

ENABLE_STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the enable_status property of a AuditSpecification. This constant has a value of “DISABLED”

ENABLE_STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the enable_status property of a AuditSpecification. This constant has a value of “ENABLED”

ENABLE_STATUS_PARTIALLY_ENABLED = 'PARTIALLY_ENABLED'¶: A constant which can be used with the enable_status property of a AuditSpecification. This constant has a value of “PARTIALLY_ENABLED”

__init__(**kwargs)¶

Initializes a new AuditSpecification object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

audit_policy_name (str) – The value to assign to the audit_policy_name property of this AuditSpecification.
database_policy_names (list[str]) – The value to assign to the database_policy_names property of this AuditSpecification.
audit_policy_category (str) – The value to assign to the audit_policy_category property of this AuditSpecification. Allowed values for this property are: “BASIC_ACTIVITY”, “ADMIN_USER_ACTIVITY”, “USER_ACTIVITY”, “ORACLE_PREDEFINED”, “COMPLIANCE_STANDARD”, “CUSTOM”, “SQL_FIREWALL_AUDITING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
enable_status (str) – The value to assign to the enable_status property of this AuditSpecification. Allowed values for this property are: “ENABLED”, “DISABLED”, “PARTIALLY_ENABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
partially_enabled_msg (str) – The value to assign to the partially_enabled_msg property of this AuditSpecification.
is_enabled_for_all_users (bool) – The value to assign to the is_enabled_for_all_users property of this AuditSpecification.
is_view_only (bool) – The value to assign to the is_view_only property of this AuditSpecification.
is_seeded_in_target (bool) – The value to assign to the is_seeded_in_target property of this AuditSpecification.
is_seeded_in_data_safe (bool) – The value to assign to the is_seeded_in_data_safe property of this AuditSpecification.
is_created (bool) – The value to assign to the is_created property of this AuditSpecification.
enabled_entities (str) – The value to assign to the enabled_entities property of this AuditSpecification. Allowed values for this property are: “ALL_USERS”, “INCLUDE_USERS”, “INCLUDE_ROLES”, “EXCLUDE_USERS”, “INCLUDE_USERS_ROLES”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

audit_policy_category¶

[Required] Gets the audit_policy_category of this AuditSpecification. The category to which the audit policy belongs.

Allowed values for this property are: “BASIC_ACTIVITY”, “ADMIN_USER_ACTIVITY”, “USER_ACTIVITY”, “ORACLE_PREDEFINED”, “COMPLIANCE_STANDARD”, “CUSTOM”, “SQL_FIREWALL_AUDITING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The audit_policy_category of this AuditSpecification.
Return type:	str

audit_policy_name¶

[Required] Gets the audit_policy_name of this AuditSpecification. Indicates the audit policy name. Refer to the documentation for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database.

Returns:	The audit_policy_name of this AuditSpecification.
Return type:	str

database_policy_names¶

[Required] Gets the database_policy_names of this AuditSpecification. Indicates the names of corresponding database policy ( or policies) in the target database.

Returns:	The database_policy_names of this AuditSpecification.
Return type:	list[str]

enable_status¶

[Required] Gets the enable_status of this AuditSpecification. Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled.

Allowed values for this property are: “ENABLED”, “DISABLED”, “PARTIALLY_ENABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The enable_status of this AuditSpecification.
Return type:	str

enabled_entities¶

[Required] Gets the enabled_entities of this AuditSpecification. Indicates on whom the audit policy is enabled.

Allowed values for this property are: “ALL_USERS”, “INCLUDE_USERS”, “INCLUDE_ROLES”, “EXCLUDE_USERS”, “INCLUDE_USERS_ROLES”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The enabled_entities of this AuditSpecification.
Return type:	str

is_created¶

[Required] Gets the is_created of this AuditSpecification. Indicates whether the policy is already created on the target database.

Returns:	The is_created of this AuditSpecification.
Return type:	bool

is_enabled_for_all_users¶

[Required] Gets the is_enabled_for_all_users of this AuditSpecification. Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions.

Returns:	The is_enabled_for_all_users of this AuditSpecification.
Return type:	bool

is_seeded_in_data_safe¶

[Required] Gets the is_seeded_in_data_safe of this AuditSpecification. Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe.

Returns:	The is_seeded_in_data_safe of this AuditSpecification.
Return type:	bool

is_seeded_in_target¶

[Required] Gets the is_seeded_in_target of this AuditSpecification. Indicates whether the audit policy is one of the predefined policies provided by Oracle Database.

Returns:	The is_seeded_in_target of this AuditSpecification.
Return type:	bool

is_view_only¶

[Required] Gets the is_view_only of this AuditSpecification. Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target.

Returns:	The is_view_only of this AuditSpecification.
Return type:	bool

partially_enabled_msg¶

Gets the partially_enabled_msg of this AuditSpecification. Provides information about the policy that has been only partially enabled.

Returns:	The partially_enabled_msg of this AuditSpecification.
Return type:	str