Show / Hide Table of Contents

Class ExportKeyDetails

The details of the key that you want to wrap and export.

Inheritance
object
ExportKeyDetails
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 ExportKeyDetails

Properties

Algorithm

Declaration
[Required(ErrorMessage = "Algorithm is required.")]
[JsonProperty(PropertyName = "algorithm")]
[JsonConverter(typeof(StringEnumConverter))]
public ExportKeyDetails.AlgorithmEnum? Algorithm { get; set; }
Property Value
Type Description
ExportKeyDetails.AlgorithmEnum?

The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. Specifying RSA_OAEP_SHA256 means that the software key is wrapped by the RSA public wrapping key provided along with the request.

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 associated with the key version you want to export.

Remarks

Required

KeyVersionId

Declaration
[JsonProperty(PropertyName = "keyVersionId")]
public string KeyVersionId { get; set; }
Property Value
Type Description
string

The OCID of the specific key version to export. If not specified, the service exports the current key version.

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.

PublicKey

Declaration
[Required(ErrorMessage = "PublicKey is required.")]
[JsonProperty(PropertyName = "publicKey")]
public string PublicKey { get; set; }
Property Value
Type Description
string

The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.

Remarks

Required

In this article
Back to top