CustomerSecretKey¶

class oci.identity.models.CustomerSecretKey(**kwargs)¶

Bases: object

A CustomerSecretKey is an Oracle-provided key for using the Object Storage Service’s Amazon S3 compatible API. The key consists of a secret key/access key pair. A user can have up to two secret keys at a time.

Note: The secret key is always an Oracle-generated string; you can’t change it to a string of your choice.

For more information, see Managing User Credentials.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CustomerSecretKey.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CustomerSecretKey.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CustomerSecretKey.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CustomerSecretKey.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a CustomerSecretKey.
`display_name`	Gets the display_name of this CustomerSecretKey.
`id`	Gets the id of this CustomerSecretKey.
`inactive_status`	Gets the inactive_status of this CustomerSecretKey.
`key`	Gets the key of this CustomerSecretKey.
`lifecycle_state`	Gets the lifecycle_state of this CustomerSecretKey.
`time_created`	Gets the time_created of this CustomerSecretKey.
`time_expires`	Gets the time_expires of this CustomerSecretKey.
`user_id`	Gets the user_id of this CustomerSecretKey.

Methods

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

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

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

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

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

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

__init__(**kwargs)¶

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

Parameters:

key (str) – The value to assign to the key property of this CustomerSecretKey.
id (str) – The value to assign to the id property of this CustomerSecretKey.
user_id (str) – The value to assign to the user_id property of this CustomerSecretKey.
display_name (str) – The value to assign to the display_name property of this CustomerSecretKey.
time_created (datetime) – The value to assign to the time_created property of this CustomerSecretKey.
time_expires (datetime) – The value to assign to the time_expires property of this CustomerSecretKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CustomerSecretKey. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this CustomerSecretKey.

display_name¶

Gets the display_name of this CustomerSecretKey. The display name you assign to the secret key. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this CustomerSecretKey.
Return type:	str

id¶

Gets the id of this CustomerSecretKey. The access key portion of the key pair.

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

inactive_status¶

Gets the inactive_status of this CustomerSecretKey. The detailed status of INACTIVE lifecycleState.

Returns:	The inactive_status of this CustomerSecretKey.
Return type:	int

key¶

Gets the key of this CustomerSecretKey. The secret key.

Returns:	The key of this CustomerSecretKey.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this CustomerSecretKey. The secret key’s current state. After creating a secret key, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: “CREATING”, “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 CustomerSecretKey.
Return type:	str

time_created¶

Gets the time_created of this CustomerSecretKey. Date and time the CustomerSecretKey object was created, in the format defined by RFC3339.

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

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

time_expires¶

Gets the time_expires of this CustomerSecretKey. Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

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

Returns:	The time_expires of this CustomerSecretKey.
Return type:	datetime

user_id¶

Gets the user_id of this CustomerSecretKey. The OCID of the user the password belongs to.

Returns:	The user_id of this CustomerSecretKey.
Return type:	str