Key

class oci.key_management.models.Key(**kwargs)

Bases: object

Key model.

LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'

A constant which can be used with the lifecycle_state property of a Key. 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 Key. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "DELETING"

LIFECYCLE_STATE_DISABLED = 'DISABLED'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "DISABLED"

LIFECYCLE_STATE_DISABLING = 'DISABLING'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "DISABLING"

LIFECYCLE_STATE_ENABLED = 'ENABLED'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "ENABLED"

LIFECYCLE_STATE_ENABLING = 'ENABLING'

A constant which can be used with the lifecycle_state property of a Key. This constant has a value of "ENABLING"

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'

A constant which can be used with the lifecycle_state property of a Key. 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 Key. 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 Key. This constant has a value of "UPDATING"

__init__(**kwargs)

Initializes a new Key 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 Key.
  • current_key_version (str) -- The value to assign to the current_key_version property of this Key.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this Key.
  • display_name (str) -- The value to assign to the display_name property of this Key.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this Key.
  • id (str) -- The value to assign to the id property of this Key.
  • key_shape (KeyShape) -- The value to assign to the key_shape property of this Key.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this Key. Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", "UPDATING", '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 Key.
  • time_of_deletion (datetime) -- The value to assign to the time_of_deletion property of this Key.
  • vault_id (str) -- The value to assign to the vault_id property of this Key.
compartment_id

[Required] Gets the compartment_id of this Key. The OCID of the compartment that contains this key.

Returns:The compartment_id of this Key.
Return type:str
current_key_version

[Required] Gets the current_key_version of this Key. The OCID of the KeyVersion resource used in cryptographic operations. During key rotation, service might be in a transitional state where this or a newer KeyVersion are used intermittently. The currentKeyVersion field is updated when the service is guaranteed to use the new KeyVersion for all subsequent encryption operations.

Returns:The current_key_version of this Key.
Return type:str
defined_tags

Gets the defined_tags of this Key. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "foo-value"}}

Returns:The defined_tags of this Key.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this Key. A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:The display_name of this Key.
Return type:str
freeform_tags

Gets the freeform_tags of this Key. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Returns:The freeform_tags of this Key.
Return type:dict(str, str)
id

[Required] Gets the id of this Key. The OCID of the key.

Returns:The id of this Key.
Return type:str
key_shape

[Required] Gets the key_shape of this Key.

Returns:The key_shape of this Key.
Return type:KeyShape
lifecycle_state

[Required] Gets the lifecycle_state of this Key. The key's current state.

Example: ENABLED

Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this Key.
Return type:str
time_created

[Required] Gets the time_created of this Key. The date and time the key was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-03T21:10:29.600Z

Returns:The time_created of this Key.
Return type:datetime
time_of_deletion

Gets the time_of_deletion of this Key. An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:The time_of_deletion of this Key.
Return type:datetime
vault_id

[Required] Gets the vault_id of this Key. The OCID of the vault that contains this key.

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