Show / Hide Table of Contents

Class KeyVersionSummary

The details of the KeyVersion.

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

Properties

CompartmentId

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

The OCID of the compartment that contains this key version.

Remarks

Required

ExternalKeyReferenceDetails

Declaration
[JsonProperty(PropertyName = "externalKeyReferenceDetails")]
public ExternalKeyReferenceDetails ExternalKeyReferenceDetails { get; set; }
Property Value
Type Description
ExternalKeyReferenceDetails

Id

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

The OCID of the key version.

Remarks

Required

IsAutoRotated

Declaration
[JsonProperty(PropertyName = "isAutoRotated")]
public bool? IsAutoRotated { get; set; }
Property Value
Type Description
bool?

An optional property indicating whether this keyversion is generated from auto rotatation.

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 this key version.

Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeyVersionSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
KeyVersionSummary.LifecycleStateEnum?

The key version's current lifecycle state.
Example: ENABLED

Origin

Declaration
[Required(ErrorMessage = "Origin is required.")]
[JsonProperty(PropertyName = "origin")]
[JsonConverter(typeof(ResponseEnumConverter))]
public KeyVersionSummary.OriginEnum? Origin { get; set; }
Property Value
Type Description
KeyVersionSummary.OriginEnum?

The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time this key version was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z

Remarks

Required

TimeOfDeletion

Declaration
[JsonProperty(PropertyName = "timeOfDeletion")]
public DateTime? TimeOfDeletion { get; set; }
Property Value
Type Description
DateTime?

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

VaultId

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

The OCID of the vault that contains this key version.

Remarks

Required

In this article
Back to top