SecurityAttribute¶

class oci.security_attribute.models.SecurityAttribute(**kwargs)¶

Bases: object

A security attribute that belongs to a specific security attribute namespace. Security attributes must be created in a tenancy before a user can apply them to resources. For more information, see Managing Security Attributes.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SecurityAttribute.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SecurityAttribute.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SecurityAttribute.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a SecurityAttribute.
`compartment_id`	[Required] Gets the compartment_id of this SecurityAttribute.
`description`	[Required] Gets the description of this SecurityAttribute.
`id`	[Required] Gets the id of this SecurityAttribute.
`is_retired`	[Required] Gets the is_retired of this SecurityAttribute.
`lifecycle_state`	Gets the lifecycle_state of this SecurityAttribute.
`name`	[Required] Gets the name of this SecurityAttribute.
`security_attribute_namespace_id`	[Required] Gets the security_attribute_namespace_id of this SecurityAttribute.
`security_attribute_namespace_name`	[Required] Gets the security_attribute_namespace_name of this SecurityAttribute.
`time_created`	[Required] Gets the time_created of this SecurityAttribute.
`type`	Gets the type of this SecurityAttribute.
`validator`	Gets the validator of this SecurityAttribute.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a SecurityAttribute. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a SecurityAttribute. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a SecurityAttribute. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a SecurityAttribute. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this SecurityAttribute.
security_attribute_namespace_id (str) – The value to assign to the security_attribute_namespace_id property of this SecurityAttribute.
security_attribute_namespace_name (str) – The value to assign to the security_attribute_namespace_name property of this SecurityAttribute.
id (str) – The value to assign to the id property of this SecurityAttribute.
name (str) – The value to assign to the name property of this SecurityAttribute.
description (str) – The value to assign to the description property of this SecurityAttribute.
type (str) – The value to assign to the type property of this SecurityAttribute.
is_retired (bool) – The value to assign to the is_retired property of this SecurityAttribute.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityAttribute. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this SecurityAttribute.
validator (oci.security_attribute.models.BaseSecurityAttributeValidator) – The value to assign to the validator property of this SecurityAttribute.

compartment_id¶

[Required] Gets the compartment_id of this SecurityAttribute. The OCID of the compartment that contains the security attribute definition.

Returns:	The compartment_id of this SecurityAttribute.
Return type:	str

description¶

[Required] Gets the description of this SecurityAttribute. The description of the security attribute.

Returns:	The description of this SecurityAttribute.
Return type:	str

id¶

[Required] Gets the id of this SecurityAttribute. The OCID of the security attribute definition.

Returns:	The id of this SecurityAttribute.
Return type:	str

is_retired¶

[Required] Gets the is_retired of this SecurityAttribute. Indicates whether the security attribute is retired. See Managing Security Attribute Namespaces.

Returns:	The is_retired of this SecurityAttribute.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this SecurityAttribute. The security attribute’s current state. After creating a security attribute, make sure its lifecycleState is ACTIVE before using it. After retiring a security attribute, make sure its lifecycleState is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted tag’s lifecycleState changes from DELETING to DELETED.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this SecurityAttribute.
Return type:	str

name¶

[Required] Gets the name of this SecurityAttribute. The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed.

Returns:	The name of this SecurityAttribute.
Return type:	str

security_attribute_namespace_id¶

[Required] Gets the security_attribute_namespace_id of this SecurityAttribute. The OCID of the security attribute namespace that contains the security attribute definition.

Returns:	The security_attribute_namespace_id of this SecurityAttribute.
Return type:	str

security_attribute_namespace_name¶

[Required] Gets the security_attribute_namespace_name of this SecurityAttribute. The name of the security attribute namespace that contains the security attribute.

Returns:	The security_attribute_namespace_name of this SecurityAttribute.
Return type:	str

time_created¶

[Required] Gets the time_created of this SecurityAttribute. Date and time the security attribute was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this SecurityAttribute.
Return type:	datetime

type¶

Gets the type of this SecurityAttribute. The data type of the security attribute.

Returns:	The type of this SecurityAttribute.
Return type:	str

validator¶

Gets the validator of this SecurityAttribute.

Returns:	The validator of this SecurityAttribute.
Return type:	oci.security_attribute.models.BaseSecurityAttributeValidator