Class GenerateKeyDetails

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

Inheritance

object

GenerateKeyDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.KeymanagementService.Models

Assembly: OCI.DotNetSDK.Keymanagement.dll

Syntax

public class GenerateKeyDetails

Properties

AssociatedData

Declaration

[JsonProperty(PropertyName = "associatedData")]
public Dictionary<string, string> AssociatedData { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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.

IncludePlaintextKey

Declaration

[Required(ErrorMessage = "IncludePlaintextKey is required.")]
[JsonProperty(PropertyName = "includePlaintextKey")]
public bool? IncludePlaintextKey { get; set; }

Property Value

Type	Description
bool?	If true, the generated key is also returned unencrypted.

Remarks

Required

KeyId

Declaration

[Required(ErrorMessage = "KeyId is required.")]
[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }

Property Value

Type	Description
string	The OCID of the master encryption key to encrypt the generated data encryption key with.

Remarks

Required

KeyShape

Declaration

[Required(ErrorMessage = "KeyShape is required.")]
[JsonProperty(PropertyName = "keyShape")]
public KeyShape KeyShape { get; set; }

Property Value

Type	Description
KeyShape

Remarks

Required

LoggingContext

Declaration

[JsonProperty(PropertyName = "loggingContext")]
public Dictionary<string, string> LoggingContext { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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.