Class EncryptDataDetails

The details of the plaintext data that you want to encrypt.

Inheritance

object

EncryptDataDetails

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 EncryptDataDetails

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.

EncryptionAlgorithm

Declaration

[JsonProperty(PropertyName = "encryptionAlgorithm")]
[JsonConverter(typeof(StringEnumConverter))]
public EncryptDataDetails.EncryptionAlgorithmEnum? EncryptionAlgorithm { get; set; }

Property Value

Type Description

Type	Description
EncryptDataDetails.EncryptionAlgorithmEnum?	The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP.

EncryptDataDetails.EncryptionAlgorithmEnum?

The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). RSA_OAEP_SHA_1 indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). RSA_OAEP_SHA_256 indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP.

KeyId

Declaration

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

Property Value

Type	Description
string	The OCID of the key to encrypt with.

Remarks

Required

KeyVersionId

Declaration

[JsonProperty(PropertyName = "keyVersionId")]
public string KeyVersionId { get; set; }

Property Value

Type	Description
string	The OCID of the key version used to encrypt the ciphertext.

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 as key-value pairs to include in the audit logs when audit logging is enabled.

Plaintext

Declaration

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

Property Value

Type	Description
string	The plaintext data to encrypt.

Remarks

Required