GenerateKeyDetails¶

class oci.key_management.models.GenerateKeyDetails(**kwargs)¶

Bases: object

The details of the key that you want to encrypt or decrypt data.

Methods

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

Attributes

`associated_data`	Gets the associated_data of this GenerateKeyDetails.
`include_plaintext_key`	[Required] Gets the include_plaintext_key of this GenerateKeyDetails.
`key_id`	[Required] Gets the key_id of this GenerateKeyDetails.
`key_shape`	[Required] Gets the key_shape of this GenerateKeyDetails.
`logging_context`	Gets the logging_context of this GenerateKeyDetails.

__init__(**kwargs)¶

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

Parameters:

associated_data (dict(str, str)) – The value to assign to the associated_data property of this GenerateKeyDetails.
include_plaintext_key (bool) – The value to assign to the include_plaintext_key property of this GenerateKeyDetails.
key_id (str) – The value to assign to the key_id property of this GenerateKeyDetails.
key_shape (oci.key_management.models.KeyShape) – The value to assign to the key_shape property of this GenerateKeyDetails.
logging_context (dict(str, str)) – The value to assign to the logging_context property of this GenerateKeyDetails.

associated_data¶

Gets the associated_data of this GenerateKeyDetails. Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters.

Returns:	The associated_data of this GenerateKeyDetails.
Return type:	dict(str, str)

include_plaintext_key¶

[Required] Gets the include_plaintext_key of this GenerateKeyDetails. If true, the generated key is also returned unencrypted.

Returns:	The include_plaintext_key of this GenerateKeyDetails.
Return type:	bool

key_id¶

[Required] Gets the key_id of this GenerateKeyDetails. The OCID of the master encryption key to encrypt the generated data encryption key with.

Returns:	The key_id of this GenerateKeyDetails.
Return type:	str

key_shape¶

[Required] Gets the key_shape of this GenerateKeyDetails.

Returns:	The key_shape of this GenerateKeyDetails.
Return type:	oci.key_management.models.KeyShape

logging_context¶

Gets the logging_context of this GenerateKeyDetails. Information that provides context for audit logging. You can provide this additional data by formatting it as key-value pairs to include in audit logs when audit logging is enabled.

Returns:	The logging_context of this GenerateKeyDetails.
Return type:	dict(str, str)