ApiKeySummary¶

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

Bases: object

Summary of the API key.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this ApiKeySummary.
`defined_tags`	Gets the defined_tags of this ApiKeySummary.
`description`	Gets the description of this ApiKeySummary.
`display_name`	[Required] Gets the display_name of this ApiKeySummary.
`freeform_tags`	Gets the freeform_tags of this ApiKeySummary.
`id`	[Required] Gets the id of this ApiKeySummary.
`keys`	[Required] Gets the keys of this ApiKeySummary.
`lifecycle_details`	Gets the lifecycle_details of this ApiKeySummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ApiKeySummary.
`system_tags`	Gets the system_tags of this ApiKeySummary.
`time_created`	[Required] Gets the time_created of this ApiKeySummary.
`time_updated`	Gets the time_updated of this ApiKeySummary.

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this ApiKeySummary.
display_name (str) – The value to assign to the display_name property of this ApiKeySummary.
description (str) – The value to assign to the description property of this ApiKeySummary.
compartment_id (str) – The value to assign to the compartment_id property of this ApiKeySummary.
time_created (datetime) – The value to assign to the time_created property of this ApiKeySummary.
time_updated (datetime) – The value to assign to the time_updated property of this ApiKeySummary.
keys (list[oci.generative_ai.models.ApiKeyItem]) – The value to assign to the keys property of this ApiKeySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ApiKeySummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ApiKeySummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ApiKeySummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ApiKeySummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ApiKeySummary.

compartment_id¶

[Required] Gets the compartment_id of this ApiKeySummary. The compartment OCID to create the apiKey in.

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

defined_tags¶

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

description¶

Gets the description of this ApiKeySummary. An optional description of the Api key.

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

display_name¶

[Required] Gets the display_name of this ApiKeySummary. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ApiKeySummary. the ApiKey id.

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

keys¶

[Required] Gets the keys of this ApiKeySummary. The list of keys.

Returns:	The keys of this ApiKeySummary.
Return type:	list[oci.generative_ai.models.ApiKeyItem]

lifecycle_details¶

Gets the lifecycle_details of this ApiKeySummary. A message describing the current state with detail that can provide actionable information.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ApiKeySummary. The current state of the API key.

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

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

system_tags¶

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

time_created¶

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

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

time_updated¶

Gets the time_updated of this ApiKeySummary. The date and time the ApiKey was updated, in the format defined by RFC 3339.

Returns:	The time_updated of this ApiKeySummary.
Return type:	datetime