SecretSummary¶

class oci.vault.models.SecretSummary(**kwargs)¶

Bases: object

The details of the secret, excluding the contents of the secret.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_CANCELLING_DELETION`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_PENDING_DELETION`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_SCHEDULING_DELETION`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SecretSummary.
`compartment_id`	[Required] Gets the compartment_id of this SecretSummary.
`defined_tags`	Gets the defined_tags of this SecretSummary.
`description`	Gets the description of this SecretSummary.
`freeform_tags`	Gets the freeform_tags of this SecretSummary.
`id`	[Required] Gets the id of this SecretSummary.
`is_auto_generation_enabled`	Gets the is_auto_generation_enabled of this SecretSummary.
`key_id`	Gets the key_id of this SecretSummary.
`last_rotation_time`	Gets the last_rotation_time of this SecretSummary.
`lifecycle_details`	Gets the lifecycle_details of this SecretSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SecretSummary.
`next_rotation_time`	Gets the next_rotation_time of this SecretSummary.
`rotation_config`	Gets the rotation_config of this SecretSummary.
`rotation_status`	Gets the rotation_status of this SecretSummary.
`secret_generation_context`	Gets the secret_generation_context of this SecretSummary.
`secret_name`	[Required] Gets the secret_name of this SecretSummary.
`system_tags`	Gets the system_tags of this SecretSummary.
`time_created`	[Required] Gets the time_created of this SecretSummary.
`time_of_current_version_expiry`	Gets the time_of_current_version_expiry of this SecretSummary.
`time_of_deletion`	Gets the time_of_deletion of this SecretSummary.
`vault_id`	[Required] Gets the vault_id of this SecretSummary.

Methods

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

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

LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “CANCELLING_DELETION”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “CREATING”

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “PENDING_DELETION”

LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “SCHEDULING_DELETION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a SecretSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new SecretSummary 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 SecretSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecretSummary.
description (str) – The value to assign to the description property of this SecretSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecretSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecretSummary.
key_id (str) – The value to assign to the key_id property of this SecretSummary.
id (str) – The value to assign to the id property of this SecretSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SecretSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecretSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
rotation_config (oci.vault.models.RotationConfig) – The value to assign to the rotation_config property of this SecretSummary.
rotation_status (str) – The value to assign to the rotation_status property of this SecretSummary.
last_rotation_time (datetime) – The value to assign to the last_rotation_time property of this SecretSummary.
next_rotation_time (datetime) – The value to assign to the next_rotation_time property of this SecretSummary.
secret_name (str) – The value to assign to the secret_name property of this SecretSummary.
time_created (datetime) – The value to assign to the time_created property of this SecretSummary.
time_of_current_version_expiry (datetime) – The value to assign to the time_of_current_version_expiry property of this SecretSummary.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this SecretSummary.
vault_id (str) – The value to assign to the vault_id property of this SecretSummary.
secret_generation_context (oci.vault.models.SecretGenerationContext) – The value to assign to the secret_generation_context property of this SecretSummary.
is_auto_generation_enabled (bool) – The value to assign to the is_auto_generation_enabled property of this SecretSummary.

compartment_id¶

[Required] Gets the compartment_id of this SecretSummary. The OCID of the compartment that contains the secret.

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

defined_tags¶

Gets the defined_tags of this SecretSummary. 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 SecretSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this SecretSummary. A brief description of the secret.

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

freeform_tags¶

Gets the freeform_tags of this SecretSummary. 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 SecretSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this SecretSummary. The OCID of the secret.

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

is_auto_generation_enabled¶

Gets the is_auto_generation_enabled of this SecretSummary. The value of this flag determines whether or not secret content will be generated automatically.

Returns:	The is_auto_generation_enabled of this SecretSummary.
Return type:	bool

key_id¶

Gets the key_id of this SecretSummary. The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

Returns:	The key_id of this SecretSummary.
Return type:	str

last_rotation_time¶

Gets the last_rotation_time of this SecretSummary. A property indicating when the secret was last rotated successfully, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The last_rotation_time of this SecretSummary.
Return type:	datetime

lifecycle_details¶

Gets the lifecycle_details of this SecretSummary. Additional information about the secret’s current lifecycle state.

Returns:	The lifecycle_details of this SecretSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this SecretSummary. The current lifecycle state of the secret.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “SCHEDULING_DELETION”, “PENDING_DELETION”, “CANCELLING_DELETION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

next_rotation_time¶

Gets the next_rotation_time of this SecretSummary. A property indicating when the secret is scheduled to be rotated, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The next_rotation_time of this SecretSummary.
Return type:	datetime

rotation_config¶

Gets the rotation_config of this SecretSummary.

Returns:	The rotation_config of this SecretSummary.
Return type:	oci.vault.models.RotationConfig

rotation_status¶

Gets the rotation_status of this SecretSummary. Additional information about the status of the secret rotation

Returns:	The rotation_status of this SecretSummary.
Return type:	str

secret_generation_context¶

Gets the secret_generation_context of this SecretSummary.

Returns:	The secret_generation_context of this SecretSummary.
Return type:	oci.vault.models.SecretGenerationContext

secret_name¶

[Required] Gets the secret_name of this SecretSummary. The name of the secret.

Returns:	The secret_name of this SecretSummary.
Return type:	str

system_tags¶

Gets the system_tags of this SecretSummary. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this SecretSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this SecretSummary. A property indicating when the secret was created, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

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

time_of_current_version_expiry¶

Gets the time_of_current_version_expiry of this SecretSummary. An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The time_of_current_version_expiry of this SecretSummary.
Return type:	datetime

time_of_deletion¶

Gets the time_of_deletion of this SecretSummary. An optional property indicating when to delete the secret, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:	The time_of_deletion of this SecretSummary.
Return type:	datetime

vault_id¶

[Required] Gets the vault_id of this SecretSummary. The OCID of the Vault in which the secret exists

Returns:	The vault_id of this SecretSummary.
Return type:	str