ApiKeyItem¶

class oci.generative_ai.models.ApiKeyItem(**kwargs)¶

Bases: object

The ApiKey item.

Attributes:

`STATE_ACTIVE`	A constant which can be used with the state property of a ApiKeyItem.
`STATE_DELETED`	A constant which can be used with the state property of a ApiKeyItem.
`STATE_EXPIRED`	A constant which can be used with the state property of a ApiKeyItem.
`STATE_INACTIVE`	A constant which can be used with the state property of a ApiKeyItem.
`STATE_REVOKED`	A constant which can be used with the state property of a ApiKeyItem.
`key`	Gets the key of this ApiKeyItem.
`key_mask`	[Required] Gets the key_mask of this ApiKeyItem.
`key_name`	[Required] Gets the key_name of this ApiKeyItem.
`state`	[Required] Gets the state of this ApiKeyItem.
`time_activated`	Gets the time_activated of this ApiKeyItem.
`time_created`	[Required] Gets the time_created of this ApiKeyItem.
`time_deactivated`	Gets the time_deactivated of this ApiKeyItem.
`time_expiry`	[Required] Gets the time_expiry of this ApiKeyItem.
`time_last_used`	Gets the time_last_used of this ApiKeyItem.
`time_revoked`	Gets the time_revoked of this ApiKeyItem.

Methods:

__init__(**kwargs)

Initializes a new ApiKeyItem object with values from keyword arguments.

STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the state property of a ApiKeyItem. This constant has a value of “ACTIVE”

STATE_DELETED = 'DELETED'¶: A constant which can be used with the state property of a ApiKeyItem. This constant has a value of “DELETED”

STATE_EXPIRED = 'EXPIRED'¶: A constant which can be used with the state property of a ApiKeyItem. This constant has a value of “EXPIRED”

STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the state property of a ApiKeyItem. This constant has a value of “INACTIVE”

STATE_REVOKED = 'REVOKED'¶: A constant which can be used with the state property of a ApiKeyItem. This constant has a value of “REVOKED”

__init__(**kwargs)¶

Initializes a new ApiKeyItem 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 ApiKeyItem.
key_name (str) – The value to assign to the key_name property of this ApiKeyItem.
key_mask (str) – The value to assign to the key_mask property of this ApiKeyItem.
time_created (datetime) – The value to assign to the time_created property of this ApiKeyItem.
time_expiry (datetime) – The value to assign to the time_expiry property of this ApiKeyItem.
time_activated (datetime) – The value to assign to the time_activated property of this ApiKeyItem.
time_deactivated (datetime) – The value to assign to the time_deactivated property of this ApiKeyItem.
time_revoked (datetime) – The value to assign to the time_revoked property of this ApiKeyItem.
time_last_used (datetime) – The value to assign to the time_last_used property of this ApiKeyItem.
state (str) – The value to assign to the state property of this ApiKeyItem. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “REVOKED”, “EXPIRED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property key¶

Gets the key of this ApiKeyItem. The key.

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

property key_mask¶

[Required] Gets the key_mask of this ApiKeyItem. The masked key.

Returns: The key_mask of this ApiKeyItem.
Return type: str

property key_name¶

[Required] Gets the key_name of this ApiKeyItem. The key name.

Returns: The key_name of this ApiKeyItem.
Return type: str

property state¶

[Required] Gets the state of this ApiKeyItem. The current state of the API key item.

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

Returns: The state of this ApiKeyItem.
Return type: str

property time_activated¶

Gets the time_activated of this ApiKeyItem. The date and time that the key is activated in the format of an RFC3339 datetime string.

Returns: The time_activated of this ApiKeyItem.
Return type: datetime

property time_created¶

[Required] Gets the time_created of this ApiKeyItem. The date and time that the key was created in the format of an RFC3339 datetime string.

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

property time_deactivated¶

Gets the time_deactivated of this ApiKeyItem. The date and time that the key is deactivated in the format of an RFC3339 datetime string.

Returns: The time_deactivated of this ApiKeyItem.
Return type: datetime

property time_expiry¶

[Required] Gets the time_expiry of this ApiKeyItem. The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.

Returns: The time_expiry of this ApiKeyItem.
Return type: datetime

property time_last_used¶

Gets the time_last_used of this ApiKeyItem. The date and time that the key is last used in the format of an RFC3339 datetime string.

Returns: The time_last_used of this ApiKeyItem.
Return type: datetime

property time_revoked¶

Gets the time_revoked of this ApiKeyItem. The date and time that the key is revoked in the format of an RFC3339 datetime string.

Returns: The time_revoked of this ApiKeyItem.
Return type: datetime