SecretVersionSummary¶

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

Bases: object

The secret version summary object, which doesn’t include the contents of the secret.

Attributes

`CONTENT_TYPE_BASE64`	A constant which can be used with the content_type property of a SecretVersionSummary.
`STAGES_CURRENT`	A constant which can be used with the stages property of a SecretVersionSummary.
`STAGES_DEPRECATED`	A constant which can be used with the stages property of a SecretVersionSummary.
`STAGES_LATEST`	A constant which can be used with the stages property of a SecretVersionSummary.
`STAGES_PENDING`	A constant which can be used with the stages property of a SecretVersionSummary.
`STAGES_PREVIOUS`	A constant which can be used with the stages property of a SecretVersionSummary.
`content_type`	Gets the content_type of this SecretVersionSummary.
`is_content_auto_generated`	Gets the is_content_auto_generated of this SecretVersionSummary.
`name`	Gets the name of this SecretVersionSummary.
`secret_id`	[Required] Gets the secret_id of this SecretVersionSummary.
`stages`	Gets the stages of this SecretVersionSummary.
`system_tags`	Gets the system_tags of this SecretVersionSummary.
`time_created`	[Required] Gets the time_created of this SecretVersionSummary.
`time_of_deletion`	Gets the time_of_deletion of this SecretVersionSummary.
`time_of_expiry`	Gets the time_of_expiry of this SecretVersionSummary.
`version_number`	[Required] Gets the version_number of this SecretVersionSummary.

Methods

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

CONTENT_TYPE_BASE64 = 'BASE64'¶: A constant which can be used with the content_type property of a SecretVersionSummary. This constant has a value of “BASE64”

STAGES_CURRENT = 'CURRENT'¶: A constant which can be used with the stages property of a SecretVersionSummary. This constant has a value of “CURRENT”

STAGES_DEPRECATED = 'DEPRECATED'¶: A constant which can be used with the stages property of a SecretVersionSummary. This constant has a value of “DEPRECATED”

STAGES_LATEST = 'LATEST'¶: A constant which can be used with the stages property of a SecretVersionSummary. This constant has a value of “LATEST”

STAGES_PENDING = 'PENDING'¶: A constant which can be used with the stages property of a SecretVersionSummary. This constant has a value of “PENDING”

STAGES_PREVIOUS = 'PREVIOUS'¶: A constant which can be used with the stages property of a SecretVersionSummary. This constant has a value of “PREVIOUS”

__init__(**kwargs)¶

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

Parameters:

content_type (str) – The value to assign to the content_type property of this SecretVersionSummary. Allowed values for this property are: “BASE64”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this SecretVersionSummary.
secret_id (str) – The value to assign to the secret_id property of this SecretVersionSummary.
stages (list[str]) – The value to assign to the stages property of this SecretVersionSummary. Allowed values for items in this list are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”, ‘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 SecretVersionSummary.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this SecretVersionSummary.
time_of_expiry (datetime) – The value to assign to the time_of_expiry property of this SecretVersionSummary.
version_number (int) – The value to assign to the version_number property of this SecretVersionSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecretVersionSummary.
is_content_auto_generated (bool) – The value to assign to the is_content_auto_generated property of this SecretVersionSummary.

content_type¶

Gets the content_type of this SecretVersionSummary. The content type of the secret version’s secret contents.

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

Returns:	The content_type of this SecretVersionSummary.
Return type:	str

is_content_auto_generated¶

Gets the is_content_auto_generated of this SecretVersionSummary. Boolean flag indicating whether secret content for this secret version was auto-generated or not.

Returns:	The is_content_auto_generated of this SecretVersionSummary.
Return type:	bool

name¶

Gets the name of this SecretVersionSummary. The name of the secret version. A name is unique across versions of a secret.

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

secret_id¶

[Required] Gets the secret_id of this SecretVersionSummary. The OCID of the secret.

Returns:	The secret_id of this SecretVersionSummary.
Return type:	str

stages¶

Gets the stages of this SecretVersionSummary. A list of possible rotation states for the secret version. A secret version marked CURRENT is currently in use. A secret version marked PENDING is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated into current, active use. The secret most recently uploaded to a vault is always marked LATEST. (The first version of a secret is always marked as both CURRENT and LATEST.) A secret version marked PREVIOUS is the secret version that was most recently marked CURRENT, before the last secret version rotation. A secret version marked DEPRECATED is neither current, pending, nor the previous one in use. Only secret versions marked DEPRECATED can be scheduled for deletion.

Allowed values for items in this list are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The stages of this SecretVersionSummary.
Return type:	list[str]

system_tags¶

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

time_created¶

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

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

time_of_deletion¶

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

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

time_of_expiry¶

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

Returns:	The time_of_expiry of this SecretVersionSummary.
Return type:	datetime

version_number¶

[Required] Gets the version_number of this SecretVersionSummary. The version number of the secret.

Returns:	The version_number of this SecretVersionSummary.
Return type:	int