CreateApiKeyDetails¶

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

Bases: object

The data to create an API key.

Methods:

__init__(**kwargs)

Initializes a new CreateApiKeyDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateApiKeyDetails.
`defined_tags`	Gets the defined_tags of this CreateApiKeyDetails.
`description`	Gets the description of this CreateApiKeyDetails.
`display_name`	[Required] Gets the display_name of this CreateApiKeyDetails.
`freeform_tags`	Gets the freeform_tags of this CreateApiKeyDetails.
`key_details`	[Required] Gets the key_details of this CreateApiKeyDetails.

__init__(**kwargs)¶

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

Parameters

display_name (str) – The value to assign to the display_name property of this CreateApiKeyDetails.
description (str) – The value to assign to the description property of this CreateApiKeyDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateApiKeyDetails.
key_details (list[oci.generative_ai.models.KeyDetails]) – The value to assign to the key_details property of this CreateApiKeyDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateApiKeyDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateApiKeyDetails.

property compartment_id¶

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

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property key_details¶

[Required] Gets the key_details of this CreateApiKeyDetails. The list of key details for creation.

Returns: The key_details of this CreateApiKeyDetails.
Return type: list[oci.generative_ai.models.KeyDetails]